version 2004
ODBC_SQLGetConnectAttr (connectionID; attribute; valuePtr) Longint
Parameter | Type | Description | |
connectionID | Longint | Connection ID | |
attribute | Longint | Attribute to retrieve | |
valuePtr | Pointer | Pointer to the current value of the attribute | |
Function result | Longint | Returns the result of the MS ODBC API function | |
SQLGetConnectAttr |
Description
The ODBC_SQLGetConnectAttr command returns the current setting of a connection attribute passed in attribute. This command can be used in conjunction with ODBC_SetConnectAttr.
connectionID is a valid connection ID returned by either ODBC_SQLAllocConnect before or ODBC_SQLConnect after having established a connection to a data source depending on attribute.
attribute is the connection attribute to retrieve and can be one of the following values:
Constant | Description |
SQL_ATTR_ACCESS_MODE | Read-only or read-write |
SQL_ATTR_ASYNC_ENABLE | Defines if a function can be executed asynchronously |
SQL_ATTR_AUTOCOMMIT | Autocommit or manual-commit mode |
SQL_ATTR_CONNECTION_TIMEOUT | Number of seconds to wait for a request to complete |
SQL_ATTR_CURRENT_CATALOG | Name of the catalog to be used by the data source |
SQL_ATTR_LOGIN_TIMEOUT | Number of seconds to wait for a login request |
SQL_ATTR_METADATA_ID | Determines how the string arguments of catalog |
functions are treated | |
SQL_ATTR_ODBC_CURSORS | Specifies how the Driver Manager uses the ODBC |
cursor | |
SQL_ATTR_PACKET_SIZE | Network packet size in bytes |
SQL_ATTR_QUIET_MODE | Does not display any dialog boxes, except |
ODBC_SQLDriverConnect | |
SQL_ATTR_TRACE | Tracing on or off |
SQL_ATTR_TRACEFILE | Name of the trace file |
SQL_ATTR_TRANSLATE_LIB | Name of a library containing to perform tasks, such as |
character set translation | |
SQL_ATTR_TRANSLATE_OPTION | A value passed to the trnaslation DLL |
SQL_ATTR_TXN_ISOLATION | Set the transaction isolation level for connection |
valuePtr is a pointer to the current value of the attribute defined in the attribute parameter. The variable valuePtr points to must be a String variable.
For more information, please see the SQLGetConnectAttr function in the MS ODBC API at http://msdn.microsoft.com/library/en-us/odbc/htm/odbcsqlgetconnectattr.asp.
Function Results
SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_NO_DATA, SQL_ERROR, or SQL_INVALID_HANDLE.
Example
The following method sets a connection attribute and then retrieves it:
C_STRING(255;vCatalogName;vNewCatalogName) vCatalogName:="MyCatalogName" $result:=ODBC_SQLSetConnectAttr ($connectionID;SQL_ATTR_CURRENT_CATALOG ;->vCatalogName) $result:=ODBC_SQLGetConnectAttr ($connectionID;SQL_ATTR_CURRENT_CATALOG ;->vNewCatalogName)
See Also