Struct SQLHENV 

pub struct SQLHENV<V: OdbcVersion = SQL_OV_ODBC3_80> { /* private fields */ }

An environment is a global context which holds information such as:

• The environment’s state
• The current environment-level diagnostics
• The handles of connections currently allocated on the environment
• The current settings of each environment attribute

Environment handle is always used in calls to SQLDataSources and SQLDrivers and sometimes in calls to SQLAllocHandle, SQLEndTran, SQLFreeHandle, SQLGetDiagField, and SQLGetDiagRec.

Documentation

https://docs.microsoft.com/en-us/sql/odbc/reference/develop-app/environment-handles

Implementations

impl<V: OdbcVersion> SQLHENV<V>

pub fn SQLDataSourcesA( &self, Direction: SQLUSMALLINT, ServerName: &mut OdbcStr<MaybeUninit<SQLCHAR>>, NameLength1Ptr: &mut impl AsMutPtr<SQLSMALLINT>, Description: &mut OdbcStr<MaybeUninit<SQLCHAR>>, NameLength2Ptr: &mut impl AsMutPtr<SQLSMALLINT>, ) -> SQLRETURN

Returns information about a data source. This function is implemented only by the Driver Manager.

For complete documentation on SQLDataSourcesA, see API reference.

Returns

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_NO_DATA, SQL_ERROR, or SQL_INVALID_HANDLE.

pub fn SQLDataSourcesW( &self, Direction: SQLUSMALLINT, ServerName: &mut OdbcStr<MaybeUninit<SQLWCHAR>>, NameLength1Ptr: &mut impl AsMutPtr<SQLSMALLINT>, Description: &mut OdbcStr<MaybeUninit<SQLWCHAR>>, NameLength2Ptr: &mut impl AsMutPtr<SQLSMALLINT>, ) -> SQLRETURN

Returns information about a data source. This function is implemented only by the Driver Manager.

For complete documentation on SQLDataSourcesW, see API reference.

Returns

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_NO_DATA, SQL_ERROR, or SQL_INVALID_HANDLE.

pub fn SQLDriversA( &self, Direction: SQLUSMALLINT, DriverDescription: &mut OdbcStr<MaybeUninit<SQLCHAR>>, DescriptionLengthPtr: &mut impl AsMutPtr<SQLSMALLINT>, DriverAttributes: &mut OdbcStr<MaybeUninit<SQLCHAR>>, AttributesLengthPtr: &mut impl AsMutPtr<SQLSMALLINT>, ) -> SQLRETURN

Lists driver descriptions and driver attribute keywords. This function is implemented only by the Driver Manager.

For complete documentation on SQLDriversA, see API reference.

Returns

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_NO_DATA, SQL_ERROR, or SQL_INVALID_HANDLE.

pub fn SQLDriversW( &self, Direction: SQLUSMALLINT, DriverDescription: &mut OdbcStr<MaybeUninit<SQLWCHAR>>, DescriptionLengthPtr: &mut impl AsMutPtr<SQLSMALLINT>, DriverAttributes: &mut OdbcStr<MaybeUninit<SQLWCHAR>>, AttributesLengthPtr: &mut impl AsMutPtr<SQLSMALLINT>, ) -> SQLRETURN

Lists driver descriptions and driver attribute keywords. This function is implemented only by the Driver Manager.

For complete documentation on SQLDriversW, see API reference.

Returns

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_NO_DATA, SQL_ERROR, or SQL_INVALID_HANDLE.

pub fn SQLGetEnvAttr<A: Ident<Type = SQLINTEGER>, T>( &self, Attribute: A, ValuePtr: Option<&mut T>, StringLengthPtr: Option<&mut MaybeUninit<T::StrLen>>, ) -> SQLRETURN

where T: AttrGet<A> + ?Sized + EnvAttr<A, V>, MaybeUninit<T::StrLen>: StrLen<SQLINTEGER>,

Returns the current setting of an environment attribute.

For complete documentation on SQLGetEnvAttr, see API reference.

Returns

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_NO_DATA, SQL_ERROR, or SQL_INVALID_HANDLE.

pub fn SQLSetEnvAttr<A: Ident<Type = SQLINTEGER>, T>( &mut self, Attribute: A, ValuePtr: T, ) -> SQLRETURN

where T: AttrSet<A> + EnvAttr<A, V>,

Sets attributes that govern aspects of environments.

For complete documentation on SQLSetEnvAttr, see API reference.

Returns

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, or SQL_INVALID_HANDLE.

Trait Implementations

impl<V: OdbcVersion> Allocate<'_, SQL_NULL_HANDLE> for SQLHENV<V>

unsafe fn from_raw(handle: NonNull<RawHandle>) -> Self

Creates handle from a raw pointer

fn SQLAllocHandle(InputHandle: &'src SRC) -> (Result<Self, ()>, SQLRETURN)

Allocates an environment, connection, statement, or descriptor handle.

fn SQLFreeHandle(self)

Frees resources associated with a specific environment, connection, statement, or descriptor handle.

impl<'env, V: OdbcVersion> Allocate<'env, SQLHENV<V>> for SQLHDBC<'env, C2, V>

unsafe fn from_raw(handle: NonNull<RawHandle>) -> Self

Creates handle from a raw pointer

fn SQLAllocHandle(InputHandle: &'src SRC) -> (Result<Self, ()>, SQLRETURN)

Allocates an environment, connection, statement, or descriptor handle.

fn SQLFreeHandle(self)

Frees resources associated with a specific environment, connection, statement, or descriptor handle.

impl<V: OdbcVersion> AsSQLHANDLE for SQLHENV<V>

fn as_SQLHANDLE(&self) -> SQLHANDLE

impl<V: Debug + OdbcVersion> Debug for SQLHENV<V>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<V: OdbcVersion> Diagnostics for SQLHENV<V>

fn SQLGetDiagFieldA<A: Ident<Type = SQLSMALLINT>, T>( &self, RecNumber: NonZeroI16, DiagIdentifier: A, DiagInfoPtr: Option<&mut T>, StringLengthPtr: Option<&mut MaybeUninit<T::StrLen>>, ) -> SQLRETURN

where T: AttrGet<A> + Ansi + ?Sized + DiagField<Self, A>, MaybeUninit<T::StrLen>: StrLen<SQLSMALLINT>,

Returns the current value of a field of a record of the diagnostic data structure (associated with a specified handle) that contains error, warning, and status information.

fn SQLGetDiagFieldW<A: Ident<Type = SQLSMALLINT>, T>( &self, RecNumber: NonZeroI16, DiagIdentifier: A, DiagInfoPtr: Option<&mut T>, StringLengthPtr: Option<&mut MaybeUninit<T::StrLen>>, ) -> SQLRETURN

where T: AttrGet<A> + Unicode + ?Sized + DiagField<Self, A>, MaybeUninit<T::StrLen>: StrLen<SQLSMALLINT>,

Returns the current value of a field of a record of the diagnostic data structure (associated with a specified handle) that contains error, warning, and status information.

fn SQLGetDiagRecA( &self, RecNumber: NonZeroI16, SQLState: &mut MaybeUninit<SQLSTATE<SQLCHAR>>, NativeErrorPtr: &mut impl AsMutPtr<SQLINTEGER>, MessageText: &mut OdbcStr<MaybeUninit<SQLCHAR>>, TextLengthPtr: &mut impl AsMutPtr<SQLSMALLINT>, ) -> SQLRETURN

Returns the current values of multiple fields of a diagnostic record that contains error, warning, and status information. Unlike SQLGetDiagField, which returns one diagnostic field per call, SQLGetDiagRec returns several commonly used fields of a diagnostic record, including the SQLSTATE, the native error code, and the diagnostic message text.

fn SQLGetDiagRecW( &self, RecNumber: NonZeroI16, SQLState: &mut MaybeUninit<SQLSTATE<SQLWCHAR>>, NativeErrorPtr: &mut impl AsMutPtr<SQLINTEGER>, MessageText: &mut OdbcStr<MaybeUninit<SQLWCHAR>>, TextLengthPtr: &mut impl AsMutPtr<SQLSMALLINT>, ) -> SQLRETURN

Returns the current values of multiple fields of a diagnostic record that contains error, warning, and status information. Unlike SQLGetDiagField, which returns one diagnostic field per call, SQLGetDiagRec returns several commonly used fields of a diagnostic record, including the SQLSTATE, the native error code, and the diagnostic message text.

impl<V: OdbcVersion> Drop for SQLHENV<V>

fn drop(&mut self)

Executes the destructor for this type.

impl<V: OdbcVersion> Handle for SQLHENV<V>

type Ident = SQL_HANDLE_ENV

impl<V: OdbcVersion> Send for SQLHENV<V>

impl<V: OdbcVersion> Sync for SQLHENV<V>