Level 1 subroutine
Return the current setting of a statement option.
call EDSGetStmtOption(HSTMT_IV,OPTION_IV,VALUE_IV )
•HSTMT_IV An input integer value that indicates the statement handle.
•OPTION_IV An input integer value indicating the option to retrieve.
•VALUE_IV An output integer value indicating the value of the option.
Description
For a list of options, refer to EDSSetStmtOption.
Return Values
EDSGetStmtOption returns EDS_SUCCESS, EDS_INVALID_HANDLE, or EDS_ERROR.
When EDSGetStmtOption returns EDS_ERROR, you can obtain an associated SQLSTATE value with more specific information by calling EDSError. The following table lists each typical SQLSTATE value and explains each one in the context of the command EDSGetStmtOption.
The following table lists possible SQLSTATE values:
SQL STATE |
Error |
Description |
IM001 |
Driver does not support this function |
The driver corresponding to the statement handle does not support the function. |
S1000 |
General error |
An error occurred for which there was no specific SQLSTATE and for which no implementation-specific SQLSTATE was defined. The error message returned by EDSError in the argument ERRORTEXT describes the error and its cause. |
S1001 |
Memory allocation failure |
The driver was unable to allocate the memory required to support execution or completion of the function. |
S1010 |
Function sequence error |
An asynchronously executing function (not this one) was called for the statement handle and was still executing when this function was called. |
S1092 |
Option type out of range |
An invalid OPTION_IV value was specified. |
S1C00 |
Driver not capable |
The driver or data source does not support the specified OPTION_IV. |
See Also
EDSGetConnectOption retrieves connection options associated with a connection handle.
EDSSetStmtOption and EDSSetConnectOption set statement options associated with a statement handle or a connection handle.
