Products Support Documentation Download
ODBC Catalog Functions
Collaboration diagram for ODBC Catalog Functions:

Functions

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

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

See https://msdn.microsoft.com/en-us/library/ms716336(v=vs.85).aspx

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

◆ SQLColumns()

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.

See http://msdn.microsoft.com/en-us/library/ms711683(v=vs.85).aspx

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

See http://msdn.microsoft.com/en-us/library/ms709315(v=vs.85).aspx

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

See http://msdn.microsoft.com/en-us/library/ms711005(v=vs.85).aspx

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

See http://msdn.microsoft.com/en-us/library/ms711701(v=vs.85).aspx

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

See http://msdn.microsoft.com/en-us/library/ms715368(v=vs.85).aspx

◆ SQLSpecialColumns()

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.

See http://msdn.microsoft.com/en-us/library/ms714602(v=vs.85).aspx

◆ 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 does not support table privileges. This function will always return an empty result set.

◆ SQLTables()

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.

See http://msdn.microsoft.com/en-us/library/ms711831(v=vs.85).aspx