SQLGetFunctions

SQLGetFunctions

This retrieves function list supported by the Altibase CLI driver.

Syntax

SQLRETURN SQLGetFunctions (
        SQLHDBC      dbc,
        SQLUSMALLINT functionId,
        SQLUSMALLINT *supported);

Arguments

Data Type	Argument	In/Output	Description
SQLHDBC	dbc	Input	Connection handle
SQLUSMALLINT	functionId	Input	Function ID
SQLUSMALLINT *	supported	Output	Array pointer receiving the supported function list

Return Values

SQL_SUCCESS
SQL_SUCCESS_WITH_INFO
SQL_INVALID_HANDLE
SQL_ERROR

Description

This retrieves function list supported by Altibase CLI driver. One list can be retrieved at a time or all lists can be retrieved with SQL_API_ALL_FUNCTIONS and SQL_API_ODBC3_ALL_FUNCTIONS.

Users should pinpoint the location suited for ID value of function in argumnet Supported. If this function is supported, SQL_TRUE is returned. Otherwise, SQL_FALSE is returned.

If using SQL_API_ALL_FUNCTIONS, users should apply pointer of array whose size is 100 to Supported pointer and pinpoint the location suited for the value of function ID.

If using SQL_API_ODBC3_ALL_FUNCTIONS, users should apply pointer of array whose size is the value of SQL_API_ODBC3_ALL_FUNCTIONS_SIZE to Supported pointer and you can check supported functions by using SQL_FUNC_EXISTS.

Diagnosis

SQLSTATE	Description	Comments
HY000	General error	No error occurs explicitly
HY001	Memory allocation error	This denotes to fail to allocate memory for handle
HY010	Function sequence error

Related Function

SQLGetInfo