SQL CLI Extension Functions
Collaboration diagram for SQL CLI Extension Functions:

Functions

SQLRETURN SQLDriverConnect (SQLHDBC ConnectionHandle, SQLHWND WindowHandle, const SQLCHAR *InConnectionString, SQLSMALLINT StringLength1, SQLCHAR *OutConnectionString, SQLSMALLINT BufferLength, SQLSMALLINT *StringLength2Ptr, SQLUSMALLINT DriverCompletion)
Driver Connect. More...
SQLRETURN SQLBindParameter (SQLHSTMT StatementHandle, SQLUSMALLINT ParameterNumber, SQLSMALLINT InputOutputType, SQLSMALLINT ValueType, SQLSMALLINT ParameterType, SQLUINTEGER ColumnSize, SQLSMALLINT DecimalDigits, SQLPOINTER ParameterValuePtr, SQLINTEGER BufferLength, SQLINTEGER *StrLen_or_IndPtr)
Bind an application variable to the parameter. More...
SQLRETURN SQLBulkOperations (SQLHSTMT StatementHandle, SQLSMALLINT Operation)
Perform bulk update opertations. More...
SQLRETURN SQLColumnPrivileges (SQLHSTMT hstmt, SQLCHAR *szCatalogName, SQLSMALLINT cbCatalogName, SQLCHAR *szSchemaName, SQLSMALLINT cbSchemaName, SQLCHAR *szTableName, SQLSMALLINT cbTableName, SQLCHAR *szColumnName, SQLSMALLINT cbColumnName)
Return a list of column privileges for a table. More...
SQLRETURN SQLDescribeParam (SQLHSTMT StatementHandle, SQLUSMALLINT ParameterNumber, SQLSMALLINT *DataTypePtr, SQLUINTEGER *ParameterSizePtr, SQLSMALLINT *DecimalDigitsPtr, SQLSMALLINT *NullablePtr)
Retrieve the detailed description of a parameter. More...
SQLRETURN SQLForeignKeys (SQLHSTMT StatementHandle, SQLCHAR *PKCatalogName, SQLSMALLINT NameLength1, SQLCHAR *PKSchemaName, SQLSMALLINT NameLength2, SQLCHAR *PKTableName, SQLSMALLINT NameLength3, SQLCHAR *FKCatalogName, SQLSMALLINT NameLength4, SQLCHAR *FKSchemaName, SQLSMALLINT NameLength5, SQLCHAR *FKTableName, SQLSMALLINT NameLength6)
Return a list of foreign keys in a table. More...
SQLRETURN SQLMoreResults (SQLHSTMT StatementHandle)
Check whether more results are avaiable for an SQL statement. More...
SQLRETURN SQLNativeSql (SQLHDBC ConnectionHandle, const SQLCHAR *InStatementText, SQLINTEGER TextLength1, SQLCHAR *OutStatementText, SQLINTEGER BufferLength, SQLINTEGER *TextLength2Ptr)
Return an SQL statement as modified by the SQL API driver. More...
SQLRETURN SQLPrimaryKeys (SQLHSTMT StatementHandle, SQLCHAR *CatalogName, SQLSMALLINT NameLength1, SQLCHAR *SchemaName, SQLSMALLINT NameLength2, SQLCHAR *TableName, SQLSMALLINT NameLength3)
Return a list of primary keys in a table. More...
SQLRETURN SQLProcedureColumns (SQLHSTMT StatementHandle, SQLCHAR *CatalogName, SQLSMALLINT NameLength1, SQLCHAR *SchemaName, SQLSMALLINT NameLength2, SQLCHAR *ProcName, SQLSMALLINT NameLength3, SQLCHAR *ColumnName, SQLSMALLINT NameLength4)
Return a list of parameters and columns for stored routines. More...
SQLRETURN SQLProcedures (SQLHSTMT StatementHandle, SQLCHAR *CatalogName, SQLSMALLINT NameLength1, SQLCHAR *SchemaName, SQLSMALLINT NameLength2, SQLCHAR *ProcName, SQLSMALLINT NameLength3)
Return the list of stored routine names registered with the data source. More...
SQLRETURN SQLSetPos (SQLHSTMT StatementHandle, SQLUSMALLINT RowNumber, SQLUSMALLINT Operation, SQLUSMALLINT LockType)
Set the cursor position in a result set. More...
SQLRETURN SQLTablePrivileges (SQLHSTMT hstmt, SQLCHAR *szCatalogName, SQLSMALLINT cbCatalogName, SQLCHAR *szSchemaName, SQLSMALLINT cbSchemaName, SQLCHAR *szTableName, SQLSMALLINT cbTableName)
Return a list of table privileges for the data source. More...

Detailed Description

Function Documentation

SQLBindParameter()

SQLRETURN SQLBindParameter ( SQLHSTMT StatementHandle,
SQLUSMALLINT ParameterNumber,
SQLSMALLINT InputOutputType,
SQLSMALLINT ValueType,
SQLSMALLINT ParameterType,
SQLUINTEGER ColumnSize,
SQLSMALLINT DecimalDigits,
SQLPOINTER ParameterValuePtr,
SQLINTEGER BufferLength,
SQLINTEGER * StrLen_or_IndPtr
)

#include <sqlext.h>

Bind an application variable to the parameter.

SQLBulkOperations()

SQLRETURN SQLBulkOperations ( SQLHSTMT StatementHandle,
SQLSMALLINT Operation
)

#include <sqlext.h>

Perform bulk update opertations.

RDM 14.1 does not support this function. A "function not supported" error will be returned.

SQLColumnPrivileges()

SQLRETURN SQLColumnPrivileges ( SQLHSTMT hstmt,
SQLCHAR * szCatalogName,
SQLSMALLINT cbCatalogName,
SQLCHAR * szSchemaName,
SQLSMALLINT cbSchemaName,
SQLCHAR * szTableName,
SQLSMALLINT cbTableName,
SQLCHAR * szColumnName,
SQLSMALLINT cbColumnName
)

#include <sqlext.h>

Return a list of column privileges for a table.

RDM 14.1 does not support column privileges. This function will always return an empty result set.

SQLDescribeParam()

SQLRETURN SQLDescribeParam ( SQLHSTMT StatementHandle,
SQLUSMALLINT ParameterNumber,
SQLSMALLINT * DataTypePtr,
SQLUINTEGER * ParameterSizePtr,
SQLSMALLINT * DecimalDigitsPtr,
SQLSMALLINT * NullablePtr
)

#include <sqlext.h>

Retrieve the detailed description of a parameter.

SQLDriverConnect()

SQLRETURN SQLDriverConnect ( SQLHDBC ConnectionHandle,
SQLHWND WindowHandle,
const SQLCHAR * InConnectionString,
SQLSMALLINT StringLength1,
SQLCHAR * OutConnectionString,
SQLSMALLINT BufferLength,
SQLSMALLINT * StringLength2Ptr,
SQLUSMALLINT DriverCompletion
)

#include <sqlext.h>

Driver Connect.

SQLForeignKeys()

SQLRETURN SQLForeignKeys ( SQLHSTMT StatementHandle,
SQLCHAR * PKCatalogName,
SQLSMALLINT NameLength1,
SQLCHAR * PKSchemaName,
SQLSMALLINT NameLength2,
SQLCHAR * PKTableName,
SQLSMALLINT NameLength3,
SQLCHAR * FKCatalogName,
SQLSMALLINT NameLength4,
SQLCHAR * FKSchemaName,
SQLSMALLINT NameLength5,
SQLCHAR * FKTableName,
SQLSMALLINT NameLength6
)

#include <sqlext.h>

Return a list of foreign keys in a table.

SQLMoreResults()

SQLRETURN SQLMoreResults ( SQLHSTMT StatementHandle )

#include <sqlext.h>

Check whether more results are avaiable for an SQL statement.

SQLNativeSql()

SQLRETURN SQLNativeSql ( SQLHDBC ConnectionHandle,
const SQLCHAR * InStatementText,
SQLINTEGER TextLength1,
SQLCHAR * OutStatementText,
SQLINTEGER BufferLength,
SQLINTEGER * TextLength2Ptr
)

#include <sqlext.h>

Return an SQL statement as modified by the SQL API driver.

SQLPrimaryKeys()

SQLRETURN SQLPrimaryKeys ( SQLHSTMT StatementHandle,
SQLCHAR * CatalogName,
SQLSMALLINT NameLength1,
SQLCHAR * SchemaName,
SQLSMALLINT NameLength2,
SQLCHAR * TableName,
SQLSMALLINT NameLength3
)

#include <sqlext.h>

Return a list of primary keys in a table.

SQLProcedureColumns()

SQLRETURN SQLProcedureColumns ( SQLHSTMT StatementHandle,
SQLCHAR * CatalogName,
SQLSMALLINT NameLength1,
SQLCHAR * SchemaName,
SQLSMALLINT NameLength2,
SQLCHAR * ProcName,
SQLSMALLINT NameLength3,
SQLCHAR * ColumnName,
SQLSMALLINT NameLength4
)

#include <sqlext.h>

Return a list of parameters and columns for stored routines.

SQLProcedures()

SQLRETURN SQLProcedures ( SQLHSTMT StatementHandle,
SQLCHAR * CatalogName,
SQLSMALLINT NameLength1,
SQLCHAR * SchemaName,
SQLSMALLINT NameLength2,
SQLCHAR * ProcName,
SQLSMALLINT NameLength3
)

#include <sqlext.h>

Return the list of stored routine names registered with the data source.

SQLSetPos()

SQLRETURN SQLSetPos ( SQLHSTMT StatementHandle,
SQLUSMALLINT RowNumber,
SQLUSMALLINT Operation,
SQLUSMALLINT LockType
)

#include <sqlext.h>

Set the cursor position in a result set.

RDM 14.1 does not support this function. A "function not supported" error will be returned.

SQLTablePrivileges()

SQLRETURN SQLTablePrivileges ( SQLHSTMT hstmt,
SQLCHAR * szCatalogName,
SQLSMALLINT cbCatalogName,
SQLCHAR * szSchemaName,
SQLSMALLINT cbSchemaName,
SQLCHAR * szTableName,
SQLSMALLINT cbTableName
)

#include <sqlext.h>

Return a list of table privileges for the data source.

RDM 14.1 does not support table privileges. This function will always return an empty result set.