Products Support Documentation Download
SQL API ODBC Functions
Collaboration diagram for SQL API ODBC Functions:

Functions

RDBC_EXPORT SQLRETURN SQLAllocHandle (SQLSMALLINT HandleType, SQLHANDLE InputHandle, SQLHANDLE *OutputHandle)
 Allocate an SQL API handle. More...
 
RDBC_EXPORT SQLRETURN SQLBindCol (SQLHSTMT StatementHandle, SQLUSMALLINT ColumnNumber, SQLSMALLINT TargetType, SQLPOINTER TargetValue, SQLINTEGER BufferLength, SQLINTEGER *StrLen_or_Ind)
 Bind an application variable to the column. More...
 
RDBC_EXPORT SQLRETURN SQLCancel (SQLHSTMT StatementHandle)
 Cancel a statement processing. More...
 
RDBC_EXPORT SQLRETURN SQLCloseCursor (SQLHSTMT StatementHandle)
 Close a cursor. More...
 
RDBC_EXPORT SQLRETURN SQLColAttribute (SQLHSTMT StatementHandle, SQLUSMALLINT ColumnNumber, SQLUSMALLINT FieldIdentifier, SQLPOINTER CharacterAttributePtr, SQLSMALLINT BufferLength, SQLSMALLINT *StringLength, SQLINTEGER *NumericAttributePtr)
 Retrieve attributes of a column. More...
 
RDBC_EXPORT SQLRETURN SQLColumns (SQLHSTMT StatementHandle, SQLCHAR *CatalogName, SQLSMALLINT NameLength1, SQLCHAR *SchemaName, SQLSMALLINT NameLength2, SQLCHAR *TableName, SQLSMALLINT NameLength3, SQLCHAR *ColumnName, SQLSMALLINT NameLength4)
 Retrieve the list of column names for a table. More...
 
RDBC_EXPORT SQLRETURN SQLConnect (SQLHDBC ConnectionHandle, const SQLCHAR *ServerName, SQLSMALLINT NameLength1, const SQLCHAR *UserName, SQLSMALLINT NameLength2, const SQLCHAR *Authentication, SQLSMALLINT NameLength3)
 Establish a connection to the database source. More...
 
RDBC_EXPORT SQLRETURN SQLCopyDesc (SQLHDESC SourceDescHandle, SQLHDESC TargetDescHandle)
 Copy one descriptor to another. More...
 
RDBC_EXPORT SQLRETURN SQLDataSources (SQLHENV EnvironmentHandle, SQLUSMALLINT Direction, SQLCHAR *ServerName, SQLSMALLINT BufferLength1, SQLSMALLINT *NameLength1, SQLCHAR *Description, SQLSMALLINT BufferLength2, SQLSMALLINT *NameLength2)
 Browse data sources. More...
 
RDBC_EXPORT SQLRETURN SQLDescribeCol (SQLHSTMT StatementHandle, SQLUSMALLINT ColumnNumber, SQLCHAR *ColumnName, SQLSMALLINT BufferLength, SQLSMALLINT *NameLengthPtr, SQLSMALLINT *DataTypePtr, SQLUINTEGER *ColumnSizePtr, SQLSMALLINT *DecimalDigitsPtr, SQLSMALLINT *NullablePtr)
 Retrieve the detailed description of a column. More...
 
RDBC_EXPORT SQLRETURN SQLDisconnect (SQLHDBC ConnectionHandle)
 Disconnect from the database source. More...
 
RDBC_EXPORT SQLRETURN SQLEndTran (SQLSMALLINT HandleType, SQLHANDLE Handle, SQLSMALLINT CompletionType)
 Commit or rollback a transaction. More...
 
RDBC_EXPORT SQLRETURN SQLExecDirect (SQLHSTMT StatementHandle, const SQLCHAR *StatementText, SQLINTEGER TextLength)
 Prepare and execute an SQL statement. More...
 
RDBC_EXPORT SQLRETURN SQLExecute (SQLHSTMT StatementHandle)
 Execute a prepared SQL statement. More...
 
RDBC_EXPORT SQLRETURN SQLFetch (SQLHSTMT StatementHandle)
 Fetch the next set of rows from the result set. More...
 
RDBC_EXPORT SQLRETURN SQLFetchScroll (SQLHSTMT StatementHandle, SQLSMALLINT FetchOrientation, SQLINTEGER FetchOffset)
 Fetch the next set of rows from the result set. More...
 
RDBC_EXPORT SQLRETURN SQLFreeHandle (SQLSMALLINT HandleType, SQLHANDLE Handle)
 Free a SQL API handle. More...
 
RDBC_EXPORT SQLRETURN SQLFreeStmt (SQLHSTMT StatementHandle, SQLUSMALLINT Option)
 Stops a statement processing. More...
 
RDBC_EXPORT SQLRETURN SQLGetConnectAttr (SQLHDBC ConnectionHandle, SQLINTEGER Attribute, SQLPOINTER Value, SQLINTEGER BufferLength, SQLINTEGER *StringLength)
 Obtain an attribute of the SQL API connection. More...
 
RDBC_EXPORT SQLRETURN SQLGetCursorName (SQLHSTMT StatementHandle, SQLCHAR *CursorName, SQLSMALLINT BufferLength, SQLSMALLINT *NameLength)
 Obtain the name of the current open cursor. More...
 
RDBC_EXPORT SQLRETURN SQLGetData (SQLHSTMT StatementHandle, SQLUSMALLINT ColumnNumber, SQLSMALLINT TargetType, SQLPOINTER TargetValue, SQLINTEGER BufferLength, SQLINTEGER *StrLen_or_Ind)
 Fetch a single next row from the result set. More...
 
RDBC_EXPORT SQLRETURN SQLGetDescField (SQLHDESC DescriptorHandle, SQLSMALLINT RecNumber, SQLSMALLINT FieldIdentifier, SQLPOINTER Value, SQLINTEGER BufferLength, SQLINTEGER *StringLength)
 Obtain the information about a single descriptor header/record field. More...
 
RDBC_EXPORT SQLRETURN SQLGetDescRec (SQLHDESC DescriptorHandle, SQLSMALLINT RecNumber, SQLCHAR *Name, SQLSMALLINT BufferLength, SQLSMALLINT *StringLengthPtr, SQLSMALLINT *TypePtr, SQLSMALLINT *SubTypePtr, SQLINTEGER *LengthPtr, SQLSMALLINT *PrecisionPtr, SQLSMALLINT *ScalePtr, SQLSMALLINT *NullablePtr)
 Obtain the information about multiple descriptor header/record fields. More...
 
RDBC_EXPORT SQLRETURN SQLGetDiagField (SQLSMALLINT HandleType, SQLHANDLE Handle, SQLSMALLINT RecNumber, SQLSMALLINT DiagIdentifier, SQLPOINTER DiagInfo, SQLSMALLINT BufferLength, SQLSMALLINT *StringLength)
 Obtain the information about a single diagnostic record field. More...
 
RDBC_EXPORT SQLRETURN SQLGetDiagRec (SQLSMALLINT HandleType, SQLHANDLE Handle, SQLSMALLINT RecNumber, SQLCHAR *Sqlstate, SQLINTEGER *NativeError, SQLCHAR *MessageText, SQLSMALLINT BufferLength, SQLSMALLINT *TextLength)
 Obtain the information about multiple diagnostic record fields. More...
 
RDBC_EXPORT SQLRETURN SQLGetEnvAttr (SQLHENV EnvironmentHandle, SQLINTEGER Attribute, SQLPOINTER Value, SQLINTEGER BufferLength, SQLINTEGER *StringLength)
 Obtain an attribute of an SQL API environment. More...
 
RDBC_EXPORT SQLRETURN SQLGetFunctions (SQLHDBC ConnectionHandle, SQLUSMALLINT FunctionId, SQLUSMALLINT *Supported)
 Return whether or not a specific SQL API function is supported. More...
 
RDBC_EXPORT SQLRETURN SQLGetInfo (SQLHDBC ConnectionHandle, SQLUSMALLINT InfoType, SQLPOINTER InfoValue, SQLSMALLINT BufferLength, SQLSMALLINT *StringLength)
 Return the information about the SQL API driver and data source. More...
 
RDBC_EXPORT SQLRETURN SQLGetStmtAttr (SQLHSTMT StatementHandle, SQLINTEGER Attribute, SQLPOINTER Value, SQLINTEGER BufferLength, SQLINTEGER *StringLength)
 Obtain an attribute of an SQL API statement. More...
 
RDBC_EXPORT SQLRETURN SQLGetTypeInfo (SQLHSTMT StatementHandle, SQLSMALLINT DataType)
 Return the information about the SQL API data types. More...
 
RDBC_EXPORT SQLRETURN SQLNumResultCols (SQLHSTMT StatementHandle, SQLSMALLINT *ColumnCount)
 Return the number of columns in a result set. More...
 
RDBC_EXPORT SQLRETURN SQLParamData (SQLHSTMT StatementHandle, SQLPOINTER *Value)
 Retrieve parameter data for the statement waiting to be executed. More...
 
RDBC_EXPORT SQLRETURN SQLPrepare (SQLHSTMT StatementHandle, const SQLCHAR *StatementText, SQLINTEGER TextLength)
 Prepare an SQL statement. More...
 
RDBC_EXPORT SQLRETURN SQLPutData (SQLHSTMT StatementHandle, SQLPOINTER Data, SQLINTEGER StrLen_or_Ind)
 Send parameterised data for insert/update. More...
 
RDBC_EXPORT SQLRETURN SQLRowCount (SQLHSTMT StatementHandle, SQLINTEGER *RowCount)
 Return the number of rows affected by INSERT/UPDATE/DELETE. More...
 
RDBC_EXPORT SQLRETURN SQLSetConnectAttr (SQLHDBC ConnectionHandle, SQLINTEGER Attribute, SQLPOINTER Value, SQLINTEGER StringLength)
 Set an attribute of the SQL API connection. More...
 
RDBC_EXPORT SQLRETURN SQLSetCursorName (SQLHSTMT StatementHandle, const SQLCHAR *CursorName, SQLSMALLINT NameLength)
 Set the name of the current open cursor. More...
 
RDBC_EXPORT SQLRETURN SQLSetDescField (SQLHDESC DescriptorHandle, SQLSMALLINT RecNumber, SQLSMALLINT FieldIdentifier, SQLPOINTER Value, SQLINTEGER BufferLength)
 Set the value of a single descriptor record field. More...
 
RDBC_EXPORT SQLRETURN SQLSetDescRec (SQLHDESC DescriptorHandle, SQLSMALLINT RecNumber, SQLSMALLINT Type, SQLSMALLINT SubType, SQLINTEGER Length, SQLSMALLINT Precision, SQLSMALLINT Scale, SQLPOINTER Data, SQLINTEGER *StringLength, SQLINTEGER *Indicator)
 Set the value of multiple descriptor record fields. More...
 
RDBC_EXPORT SQLRETURN SQLSetEnvAttr (SQLHENV EnvironmentHandle, SQLINTEGER Attribute, SQLPOINTER Value, SQLINTEGER StringLength)
 Obtain an attribute of an SQL API environment. More...
 
RDBC_EXPORT SQLRETURN SQLSetStmtAttr (SQLHSTMT StatementHandle, SQLINTEGER Attribute, SQLPOINTER Value, SQLINTEGER StringLength)
 Set an attribute of an SQL API statement. More...
 
RDBC_EXPORT SQLRETURN SQLSpecialColumns (SQLHSTMT StatementHandle, SQLUSMALLINT IdentifierType, SQLCHAR *CatalogName, SQLSMALLINT NameLength1, SQLCHAR *SchemaName, SQLSMALLINT NameLength2, SQLCHAR *TableName, SQLSMALLINT NameLength3, SQLUSMALLINT Scope, SQLUSMALLINT Nullable)
 Retrieve the information about special columns. More...
 
RDBC_EXPORT SQLRETURN SQLStatistics (SQLHSTMT StatementHandle, SQLCHAR *CatalogName, SQLSMALLINT NameLength1, SQLCHAR *SchemaName, SQLSMALLINT NameLength2, SQLCHAR *TableName, SQLSMALLINT NameLength3, SQLUSMALLINT Unique, SQLUSMALLINT Reserved)
 Retrieve the statistics about the specified tables. More...
 
RDBC_EXPORT SQLRETURN SQLTables (SQLHSTMT StatementHandle, SQLCHAR *CatalogName, SQLSMALLINT NameLength1, SQLCHAR *SchemaName, SQLSMALLINT NameLength2, SQLCHAR *TableName, SQLSMALLINT NameLength3, SQLCHAR *TableType, SQLSMALLINT NameLength4)
 Retrieve the list of table names for a catalog/database. More...
 
RDBC_EXPORT 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...
 
RDBC_EXPORT SQLRETURN SQLBulkOperations (SQLHSTMT StatementHandle, SQLSMALLINT Operation)
 Perform bulk update opertations. More...
 
RDBC_EXPORT 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...
 
RDBC_EXPORT SQLRETURN SQLDescribeParam (SQLHSTMT StatementHandle, SQLUSMALLINT ParameterNumber, SQLSMALLINT *DataTypePtr, SQLUINTEGER *ParameterSizePtr, SQLSMALLINT *DecimalDigitsPtr, SQLSMALLINT *NullablePtr)
 Retrieve the detailed description of a parameter. More...
 
RDBC_EXPORT 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...
 
RDBC_EXPORT SQLRETURN SQLMoreResults (SQLHSTMT StatementHandle)
 Check whether more results are avaiable for an SQL statement. More...
 
RDBC_EXPORT 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...
 
RDBC_EXPORT SQLRETURN SQLNumParams (SQLHSTMT StatementHandle, SQLSMALLINT *ParameterCountPtr)
 Return the number of parameters in an SQL statement. More...
 
RDBC_EXPORT 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...
 
RDBC_EXPORT 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...
 
RDBC_EXPORT 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...
 
RDBC_EXPORT SQLRETURN SQLSetPos (SQLHSTMT StatementHandle, SQLUSMALLINT RowNumber, SQLUSMALLINT Operation, SQLUSMALLINT LockType)
 Set the cursor position in a result set. More...
 
RDBC_EXPORT 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

Note
For complete documentation of the SQL API functions, refer to the ODBC Programmer's Reference [4] on Microsoft's documentation web site.

All the fuctions here are located in RDM SQL API Library. Linker option:

    -lrdmrdbc

.

Function Documentation

◆ SQLAllocHandle()

RDBC_EXPORT SQLRETURN SQLAllocHandle ( SQLSMALLINT  HandleType,
SQLHANDLE  InputHandle,
SQLHANDLE OutputHandle 
)

#include <sql.h>

Allocate an SQL API handle.

◆ SQLBindCol()

RDBC_EXPORT SQLRETURN SQLBindCol ( SQLHSTMT  StatementHandle,
SQLUSMALLINT  ColumnNumber,
SQLSMALLINT  TargetType,
SQLPOINTER  TargetValue,
SQLINTEGER  BufferLength,
SQLINTEGER StrLen_or_Ind 
)

#include <sql.h>

Bind an application variable to the column.

◆ SQLBindParameter()

RDBC_EXPORT 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()

RDBC_EXPORT 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.

◆ SQLCancel()

RDBC_EXPORT SQLRETURN SQLCancel ( SQLHSTMT  StatementHandle)

#include <sql.h>

Cancel a statement processing.

◆ SQLCloseCursor()

RDBC_EXPORT SQLRETURN SQLCloseCursor ( SQLHSTMT  StatementHandle)

#include <sql.h>

Close a cursor.

◆ SQLColAttribute()

RDBC_EXPORT SQLRETURN SQLColAttribute ( SQLHSTMT  StatementHandle,
SQLUSMALLINT  ColumnNumber,
SQLUSMALLINT  FieldIdentifier,
SQLPOINTER  CharacterAttributePtr,
SQLSMALLINT  BufferLength,
SQLSMALLINT StringLength,
SQLINTEGER NumericAttributePtr 
)

#include <sql.h>

Retrieve attributes of a column.

◆ SQLColumnPrivileges()

RDBC_EXPORT 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.

◆ SQLColumns()

RDBC_EXPORT SQLRETURN SQLColumns ( SQLHSTMT  StatementHandle,
SQLCHAR CatalogName,
SQLSMALLINT  NameLength1,
SQLCHAR SchemaName,
SQLSMALLINT  NameLength2,
SQLCHAR TableName,
SQLSMALLINT  NameLength3,
SQLCHAR ColumnName,
SQLSMALLINT  NameLength4 
)

#include <sql.h>

Retrieve the list of column names for a table.

◆ SQLConnect()

RDBC_EXPORT SQLRETURN SQLConnect ( SQLHDBC  ConnectionHandle,
const SQLCHAR ServerName,
SQLSMALLINT  NameLength1,
const SQLCHAR UserName,
SQLSMALLINT  NameLength2,
const SQLCHAR Authentication,
SQLSMALLINT  NameLength3 
)

#include <sql.h>

Establish a connection to the database source.

◆ SQLCopyDesc()

RDBC_EXPORT SQLRETURN SQLCopyDesc ( SQLHDESC  SourceDescHandle,
SQLHDESC  TargetDescHandle 
)

#include <sql.h>

Copy one descriptor to another.

◆ SQLDataSources()

RDBC_EXPORT SQLRETURN SQLDataSources ( SQLHENV  EnvironmentHandle,
SQLUSMALLINT  Direction,
SQLCHAR ServerName,
SQLSMALLINT  BufferLength1,
SQLSMALLINT NameLength1,
SQLCHAR Description,
SQLSMALLINT  BufferLength2,
SQLSMALLINT NameLength2 
)

#include <sql.h>

Browse data sources.

◆ SQLDescribeCol()

RDBC_EXPORT SQLRETURN SQLDescribeCol ( SQLHSTMT  StatementHandle,
SQLUSMALLINT  ColumnNumber,
SQLCHAR ColumnName,
SQLSMALLINT  BufferLength,
SQLSMALLINT NameLengthPtr,
SQLSMALLINT DataTypePtr,
SQLUINTEGER ColumnSizePtr,
SQLSMALLINT DecimalDigitsPtr,
SQLSMALLINT NullablePtr 
)

#include <sql.h>

Retrieve the detailed description of a column.

◆ SQLDescribeParam()

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

#include <sqlext.h>

Retrieve the detailed description of a parameter.

◆ SQLDisconnect()

RDBC_EXPORT SQLRETURN SQLDisconnect ( SQLHDBC  ConnectionHandle)

#include <sql.h>

Disconnect from the database source.

◆ SQLEndTran()

RDBC_EXPORT SQLRETURN SQLEndTran ( SQLSMALLINT  HandleType,
SQLHANDLE  Handle,
SQLSMALLINT  CompletionType 
)

#include <sql.h>

Commit or rollback a transaction.

◆ SQLExecDirect()

RDBC_EXPORT SQLRETURN SQLExecDirect ( SQLHSTMT  StatementHandle,
const SQLCHAR StatementText,
SQLINTEGER  TextLength 
)

#include <sql.h>

Prepare and execute an SQL statement.

◆ SQLExecute()

RDBC_EXPORT SQLRETURN SQLExecute ( SQLHSTMT  StatementHandle)

#include <sql.h>

Execute a prepared SQL statement.

◆ SQLFetch()

RDBC_EXPORT SQLRETURN SQLFetch ( SQLHSTMT  StatementHandle)

#include <sql.h>

Fetch the next set of rows from the result set.

◆ SQLFetchScroll()

RDBC_EXPORT SQLRETURN SQLFetchScroll ( SQLHSTMT  StatementHandle,
SQLSMALLINT  FetchOrientation,
SQLINTEGER  FetchOffset 
)

#include <sql.h>

Fetch the next set of rows from the result set.

◆ SQLForeignKeys()

RDBC_EXPORT 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.

◆ SQLFreeHandle()

RDBC_EXPORT SQLRETURN SQLFreeHandle ( SQLSMALLINT  HandleType,
SQLHANDLE  Handle 
)

#include <sql.h>

Free a SQL API handle.

◆ SQLFreeStmt()

RDBC_EXPORT SQLRETURN SQLFreeStmt ( SQLHSTMT  StatementHandle,
SQLUSMALLINT  Option 
)

#include <sql.h>

Stops a statement processing.

◆ SQLGetConnectAttr()

RDBC_EXPORT SQLRETURN SQLGetConnectAttr ( SQLHDBC  ConnectionHandle,
SQLINTEGER  Attribute,
SQLPOINTER  Value,
SQLINTEGER  BufferLength,
SQLINTEGER StringLength 
)

#include <sql.h>

Obtain an attribute of the SQL API connection.

◆ SQLGetCursorName()

RDBC_EXPORT SQLRETURN SQLGetCursorName ( SQLHSTMT  StatementHandle,
SQLCHAR CursorName,
SQLSMALLINT  BufferLength,
SQLSMALLINT NameLength 
)

#include <sql.h>

Obtain the name of the current open cursor.

◆ SQLGetData()

RDBC_EXPORT SQLRETURN SQLGetData ( SQLHSTMT  StatementHandle,
SQLUSMALLINT  ColumnNumber,
SQLSMALLINT  TargetType,
SQLPOINTER  TargetValue,
SQLINTEGER  BufferLength,
SQLINTEGER StrLen_or_Ind 
)

#include <sql.h>

Fetch a single next row from the result set.

◆ SQLGetDescField()

RDBC_EXPORT SQLRETURN SQLGetDescField ( SQLHDESC  DescriptorHandle,
SQLSMALLINT  RecNumber,
SQLSMALLINT  FieldIdentifier,
SQLPOINTER  Value,
SQLINTEGER  BufferLength,
SQLINTEGER StringLength 
)

#include <sql.h>

Obtain the information about a single descriptor header/record field.

◆ SQLGetDescRec()

RDBC_EXPORT SQLRETURN SQLGetDescRec ( SQLHDESC  DescriptorHandle,
SQLSMALLINT  RecNumber,
SQLCHAR Name,
SQLSMALLINT  BufferLength,
SQLSMALLINT StringLengthPtr,
SQLSMALLINT TypePtr,
SQLSMALLINT SubTypePtr,
SQLINTEGER LengthPtr,
SQLSMALLINT PrecisionPtr,
SQLSMALLINT ScalePtr,
SQLSMALLINT NullablePtr 
)

#include <sql.h>

Obtain the information about multiple descriptor header/record fields.

◆ SQLGetDiagField()

RDBC_EXPORT SQLRETURN SQLGetDiagField ( SQLSMALLINT  HandleType,
SQLHANDLE  Handle,
SQLSMALLINT  RecNumber,
SQLSMALLINT  DiagIdentifier,
SQLPOINTER  DiagInfo,
SQLSMALLINT  BufferLength,
SQLSMALLINT StringLength 
)

#include <sql.h>

Obtain the information about a single diagnostic record field.

◆ SQLGetDiagRec()

RDBC_EXPORT SQLRETURN SQLGetDiagRec ( SQLSMALLINT  HandleType,
SQLHANDLE  Handle,
SQLSMALLINT  RecNumber,
SQLCHAR Sqlstate,
SQLINTEGER NativeError,
SQLCHAR MessageText,
SQLSMALLINT  BufferLength,
SQLSMALLINT TextLength 
)

#include <sql.h>

Obtain the information about multiple diagnostic record fields.

Note
Possible return values for NativeError will be RDM_RETCODE values.

◆ SQLGetEnvAttr()

RDBC_EXPORT SQLRETURN SQLGetEnvAttr ( SQLHENV  EnvironmentHandle,
SQLINTEGER  Attribute,
SQLPOINTER  Value,
SQLINTEGER  BufferLength,
SQLINTEGER StringLength 
)

#include <sql.h>

Obtain an attribute of an SQL API environment.

◆ SQLGetFunctions()

RDBC_EXPORT SQLRETURN SQLGetFunctions ( SQLHDBC  ConnectionHandle,
SQLUSMALLINT  FunctionId,
SQLUSMALLINT Supported 
)

#include <sql.h>

Return whether or not a specific SQL API function is supported.

◆ SQLGetInfo()

RDBC_EXPORT SQLRETURN SQLGetInfo ( SQLHDBC  ConnectionHandle,
SQLUSMALLINT  InfoType,
SQLPOINTER  InfoValue,
SQLSMALLINT  BufferLength,
SQLSMALLINT StringLength 
)

#include <sql.h>

Return the information about the SQL API driver and data source.

◆ SQLGetStmtAttr()

RDBC_EXPORT SQLRETURN SQLGetStmtAttr ( SQLHSTMT  StatementHandle,
SQLINTEGER  Attribute,
SQLPOINTER  Value,
SQLINTEGER  BufferLength,
SQLINTEGER StringLength 
)

#include <sql.h>

Obtain an attribute of an SQL API statement.

◆ SQLGetTypeInfo()

RDBC_EXPORT SQLRETURN SQLGetTypeInfo ( SQLHSTMT  StatementHandle,
SQLSMALLINT  DataType 
)

#include <sql.h>

Return the information about the SQL API data types.

◆ SQLMoreResults()

RDBC_EXPORT SQLRETURN SQLMoreResults ( SQLHSTMT  StatementHandle)

#include <sqlext.h>

Check whether more results are avaiable for an SQL statement.

◆ SQLNativeSql()

RDBC_EXPORT 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.

◆ SQLNumParams()

RDBC_EXPORT SQLRETURN SQLNumParams ( SQLHSTMT  StatementHandle,
SQLSMALLINT ParameterCountPtr 
)

#include <sqlext.h>

Return the number of parameters in an SQL statement.

◆ SQLNumResultCols()

RDBC_EXPORT SQLRETURN SQLNumResultCols ( SQLHSTMT  StatementHandle,
SQLSMALLINT ColumnCount 
)

#include <sql.h>

Return the number of columns in a result set.

◆ SQLParamData()

RDBC_EXPORT SQLRETURN SQLParamData ( SQLHSTMT  StatementHandle,
SQLPOINTER Value 
)

#include <sql.h>

Retrieve parameter data for the statement waiting to be executed.

◆ SQLPrepare()

RDBC_EXPORT SQLRETURN SQLPrepare ( SQLHSTMT  StatementHandle,
const SQLCHAR StatementText,
SQLINTEGER  TextLength 
)

#include <sql.h>

Prepare an SQL statement.

◆ SQLPrimaryKeys()

RDBC_EXPORT 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()

RDBC_EXPORT 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()

RDBC_EXPORT 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.

◆ SQLPutData()

RDBC_EXPORT SQLRETURN SQLPutData ( SQLHSTMT  StatementHandle,
SQLPOINTER  Data,
SQLINTEGER  StrLen_or_Ind 
)

#include <sql.h>

Send parameterised data for insert/update.

◆ SQLRowCount()

RDBC_EXPORT SQLRETURN SQLRowCount ( SQLHSTMT  StatementHandle,
SQLINTEGER RowCount 
)

#include <sql.h>

Return the number of rows affected by INSERT/UPDATE/DELETE.

◆ SQLSetConnectAttr()

RDBC_EXPORT SQLRETURN SQLSetConnectAttr ( SQLHDBC  ConnectionHandle,
SQLINTEGER  Attribute,
SQLPOINTER  Value,
SQLINTEGER  StringLength 
)

#include <sql.h>

Set an attribute of the SQL API connection.

◆ SQLSetCursorName()

RDBC_EXPORT SQLRETURN SQLSetCursorName ( SQLHSTMT  StatementHandle,
const SQLCHAR CursorName,
SQLSMALLINT  NameLength 
)

#include <sql.h>

Set the name of the current open cursor.

◆ SQLSetDescField()

RDBC_EXPORT SQLRETURN SQLSetDescField ( SQLHDESC  DescriptorHandle,
SQLSMALLINT  RecNumber,
SQLSMALLINT  FieldIdentifier,
SQLPOINTER  Value,
SQLINTEGER  BufferLength 
)

#include <sql.h>

Set the value of a single descriptor record field.

◆ SQLSetDescRec()

RDBC_EXPORT SQLRETURN SQLSetDescRec ( SQLHDESC  DescriptorHandle,
SQLSMALLINT  RecNumber,
SQLSMALLINT  Type,
SQLSMALLINT  SubType,
SQLINTEGER  Length,
SQLSMALLINT  Precision,
SQLSMALLINT  Scale,
SQLPOINTER  Data,
SQLINTEGER StringLength,
SQLINTEGER Indicator 
)

#include <sql.h>

Set the value of multiple descriptor record fields.

◆ SQLSetEnvAttr()

RDBC_EXPORT SQLRETURN SQLSetEnvAttr ( SQLHENV  EnvironmentHandle,
SQLINTEGER  Attribute,
SQLPOINTER  Value,
SQLINTEGER  StringLength 
)

#include <sql.h>

Obtain an attribute of an SQL API environment.

◆ SQLSetPos()

RDBC_EXPORT 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.

◆ SQLSetStmtAttr()

RDBC_EXPORT SQLRETURN SQLSetStmtAttr ( SQLHSTMT  StatementHandle,
SQLINTEGER  Attribute,
SQLPOINTER  Value,
SQLINTEGER  StringLength 
)

#include <sql.h>

Set an attribute of an SQL API statement.

◆ SQLSpecialColumns()

RDBC_EXPORT SQLRETURN SQLSpecialColumns ( SQLHSTMT  StatementHandle,
SQLUSMALLINT  IdentifierType,
SQLCHAR CatalogName,
SQLSMALLINT  NameLength1,
SQLCHAR SchemaName,
SQLSMALLINT  NameLength2,
SQLCHAR TableName,
SQLSMALLINT  NameLength3,
SQLUSMALLINT  Scope,
SQLUSMALLINT  Nullable 
)

#include <sql.h>

Retrieve the information about special columns.

◆ SQLStatistics()

RDBC_EXPORT SQLRETURN SQLStatistics ( SQLHSTMT  StatementHandle,
SQLCHAR CatalogName,
SQLSMALLINT  NameLength1,
SQLCHAR SchemaName,
SQLSMALLINT  NameLength2,
SQLCHAR TableName,
SQLSMALLINT  NameLength3,
SQLUSMALLINT  Unique,
SQLUSMALLINT  Reserved 
)

#include <sql.h>

Retrieve the statistics about the specified tables.

◆ SQLTablePrivileges()

RDBC_EXPORT 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.

◆ SQLTables()

RDBC_EXPORT SQLRETURN SQLTables ( SQLHSTMT  StatementHandle,
SQLCHAR CatalogName,
SQLSMALLINT  NameLength1,
SQLCHAR SchemaName,
SQLSMALLINT  NameLength2,
SQLCHAR TableName,
SQLSMALLINT  NameLength3,
SQLCHAR TableType,
SQLSMALLINT  NameLength4 
)

#include <sql.h>

Retrieve the list of table names for a catalog/database.