Please enable JavaScript to view this site.

ESL Documentation

Level 1 subroutine

Determine if a driver supports a specific ODBC function.

call EDSGetFunctions(HDBC_IV, FUNCTION_IV , EXISTS_IV) 

HDBC_IV An input integer value indicating the connection handle.

FUNCTION_IV An input integer value indicating the ODBC function of interest. For a list of valid values, see the Description section for this command.

EXISTS_IV An output integer function that is EDS_TRUE if the specified function is supported by the driver associated with the connection handle. Otherwise, this value is EDS_FALSE.

 

Description

The following are valid values for FUNCTION_IV for EDS Core level commands. The constants are defined in the EDSEXT.INC file.

EDS_API_EDSALLOCCONNECT

EDS_API_EDSALLOCENV

EDS_API_EDSALLOCSTMT

EDS_API_EDSBINDCOL

EDS_API_EDSCANCEL

EDS_API_EDSCOLATTRIBUTES

EDS_API_EDSCONNECT

EDS_API_EDSDESCRIBECOL

EDS_API_EDSDISCONNECT

EDS_API_EDSERROR

EDS_API_EDSEXECDIRECT

EDS_API_EDSEXECUTE

EDS_API_EDSFETCH

EDS_API_EDSFREECONNECT

EDS_API_EDSFREEENV

EDS_API_EDSFREESTMT

EDS_API_EDSGETCURSORNAME

EDS_API_EDSNUMRESULTCOLS

EDS_API_EDSPREPARE

EDS_API_EDSROWCOUNT

EDS_API_EDSSETCURSORNAME

EDS_API_EDSSETPARAM

EDS_API_EDSTRANSACT

The following are valid values for FUNCTION_IV for EDS Level 1 commands.

EDS_API_EDSCOLUMNS
EDS_API_EDSDRIVERCONNECT
EDS_API_EDSGETCONNECTOPTION
EDS_API_EDSGETDATA
EDS_API_EDSGETFUNCTIONS
EDS_API_EDSGETINFO
EDS_API_EDSGETSTMTOPTION
EDS_API_EDSGETTYPEINFO
EDS_API_EDSPARAMDATA
EDS_API_EDSPUTDATA
EDS_API_EDSSETCONNECTOPTION
EDS_API_EDSSETSTMTOPTION
EDS_API_EDSSPECIALCOLUMNS
EDS_API_EDSSTATISTICS
EDS_API_EDSTABLES

The following are valid values for FUNCTION_IV for EDS Level 2 commands.

EDS_API_EDSBROWSECONNECT
EDS_API_EDSCOLUMNPRIVILEGES
EDS_API_EDSDATASOURCES
EDS_API_EDSDESCRIBEPARAM
EDS_API_EDSEXTENDEDFETCH
EDS_API_EDSFOREIGNKEYS
EDS_API_EDSMORERESULTS
EDS_API_EDSNATIVEEDS
EDS_API_EDSNUMPARAMS
EDS_API_EDSPARAMOPTIONS
EDS_API_EDSPRIMARYKEYS
EDS_API_EDSPROCEDURECOLUMNS
EDS_API_EDSPROCEDURES
EDS_API_EDSSETPOS
EDS_API_EDSSETSCROLLOPTIONS
EDS_API_EDSTABLEPRIVILEGES

Return Values

EDSGetFunctions returns EDS_SUCCESS, EDS_ERROR, or EDS_INVALID_HANDLE.

When EDSGetFunctions 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 EDSGetFunctions.

The following table lists possible SQLSTATE values:

SQL

STATE

Error

Description

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

EDSGetFunctions was called before EDSConnect, EDSBrowseConnect, or EDSDriverConnect.

S1095

Function type out . of range

An invalid FUNCTION_IV value was specified

See Also

EDSGetInfo describes the driver and data source.

EDSGetStmtOption and EDSGetConnectOption retrieve values of options that govern specific aspects of driver operation.