SQLGetFunctions Function

Conformità
Versione introdotta: Conformità agli standard ODBC 1.0: ISO 92

Riepilogo
SQLGetFunctions restituisce informazioni su se un driver supporta una funzione ODBC specifica. Questa funzione viene implementata in Gestione driver; può anche essere implementato nei driver. Se un driver implementa SQLGetFunctions, Gestione driver chiama la funzione nel driver. In caso contrario, esegue la funzione stessa.

Sintassi

  
SQLRETURN SQLGetFunctions(  
     SQLHDBC           ConnectionHandle,  
     SQLUSMALLINT      FunctionId,  
     SQLUSMALLINT *    SupportedPtr);  

Argomenti

ConnectionHandle
[Input] Handle di connessione.

FunctionId
[Input] Valore #define che identifica la funzione ODBC di interesse; SQL_API_ODBC3_ALL_FUNCTIONS orSQL_API_ALL_FUNCTIONS. SQL_API_ODBC3_ALL_FUNCTIONS viene usato da un'applicazione ODBC 3*.x* per determinare il supporto delle funzioni ODBC 3*.x* e precedenti. SQL_API_ALL_FUNCTIONS viene usato da un'applicazione ODBC 2*.x* per determinare il supporto delle funzioni ODBC 2*.x* e precedenti.

Per un elenco di valori #define che identificano le funzioni ODBC, vedere le tabelle in "Commenti".

SupportedPtr
[Output] Se FunctionId identifica una singola funzione ODBC, SupportedPtr punta a un singolo valore SQLUSMALLINT SQL_TRUE se la funzione specificata è supportata dal driver e SQL_FALSE se non è supportata.

Se FunctionId è SQL_API_ODBC3_ALL_FUNCTIONS, SupportedPtr punta a una matrice SQLSMALLINT con un numero di elementi uguale a SQL_API_ODBC3_ALL_FUNCTIONS_SIZE. Questa matrice viene considerata da Gestione driver come bitmap a 4.000 bit che può essere usata per determinare se è supportata una funzione ODBC 3*.x* o precedente. La macro SQL_FUNC_EXISTS viene chiamata per determinare il supporto delle funzioni. (Vedere "Comments.") Un'applicazione ODBC 3*.x* può chiamare SQLGetFunctions con SQL_API_ODBC3_ALL_FUNCTIONS su un driver ODBC 3*.x* o ODBC 2*.x*.

Se FunctionId è SQL_API_ALL_FUNCTIONS, SupportedPtr punta a una matrice SQLUSMALLINT di 100 elementi. La matrice viene indicizzata da #define valori utilizzati da FunctionId per identificare ogni funzione ODBC. Alcuni elementi della matrice non vengono usati e riservati per un uso futuro. Un elemento è SQL_TRUE se identifica una funzione ODBC 2*.x* o precedente supportata dal driver. È SQL_FALSE se identifica una funzione ODBC non supportata dal driver o non identifica una funzione ODBC.

Le matrici restituite in *SupportedPtr usano l'indicizzazione in base zero.

Resi

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR o SQL_INVALID_HANDLE.

Diagnostica

Quando SQLGetFunctions restituisce SQL_ERROR o SQL_SUCCESS_WITH_INFO, è possibile ottenere un valore SQLSTATE associato chiamando SQLGetDiagRec con handleType di SQL_HANDLE_DBC e handle di ConnectionHandle. La tabella seguente elenca i valori SQLSTATE comunemente restituiti da SQLGetFunctions e spiega ognuno di essi nel contesto di questa funzione. La notazione "(DM)" precede le descrizioni di SQLSTATEs restituite da Gestione driver. Il codice restituito associato a ogni valore SQLSTATE è SQL_ERROR, a meno che non sia specificato diversamente.

Commenti

SQLGetFunctions restituisce sempre che sono supportati SQLGetFunctions, SQLDataSources e SQLDrivers . Ciò avviene perché queste funzioni vengono implementate in Gestione driver. Gestione driver eseguirà il mapping di una funzione ANSI alla funzione Unicode corrispondente, se esiste la funzione Unicode e eseguirà il mapping di una funzione Unicode alla funzione ANSI corrispondente, se esiste la funzione ANSI. Per informazioni su come le applicazioni usano SQLGetFunctions, vedere Livelli di conformità dell'interfaccia.

Di seguito è riportato un elenco di valori validi per FunctionId per le funzioni conformi al livello di conformità agli standard ISO 92:

Di seguito è riportato un elenco di valori validi per FunctionId per le funzioni conformi al livello di conformità standard open group:

Di seguito è riportato un elenco di valori validi per FunctionId per le funzioni conformi al livello di conformità agli standard ODBC.

[1] Quando si utilizza un driver ODBC 2*.x*, SQLBulkOperations verrà restituito come supportato solo se sono soddisfatte entrambe le condizioni seguenti: il driver ODBC 2*.x* supporta SQLSetPos e il tipo di informazioni SQL_POS_OPERATIONS restituisce il bit SQL_POS_ADD impostato.

Di seguito è riportato un elenco di valori validi per FunctionId per le funzioni introdotte in ODBC 3.8 o versioni successive:

[2] SQLCancelHandle verrà restituito come supportato solo se il driver supporta sia SQLCancel che SQLCancelHandle. Se SQLCancel è supportato ma SQLCancelHandle non è, l'applicazione può comunque chiamare SQLCancelHandle in un handle di istruzione, perché verrà eseguito il mapping a SQLCancel.

SQL_FUNC_EXISTS Macro

La macro SQL_FUNC_EXISTS(SupportedPtr, FunctionID) viene usata per determinare il supporto delle funzioni ODBC 3*.x* o precedenti dopo che SQLGetFunctions è stato chiamato con un argomento FunctionId di SQL_API_ODBC3_ALL_FUNCTIONS. L'applicazione chiama SQL_FUNC_EXISTS con l'argomento SupportedPtr impostato su SupportedPtr passato in SQLGetFunctions e con l'argomento FunctionID impostato sul #define per la funzione. SQL_FUNC_EXISTS restituisce SQL_TRUE se la funzione è supportata e SQL_FALSE in caso contrario.

Esempio di codice

I tre esempi seguenti illustrano come un'applicazione usa SQLGetFunctions per determinare se un driver supporta tabelle SQLTable, SQLColumns e SQLStatistics. Se il driver non supporta queste funzioni, l'applicazione si disconnette dal driver. Il primo esempio chiama SQLGetFunctions una volta per ogni funzione.

SQLUSMALLINT TablesExists, ColumnsExists, StatisticsExists;  
RETCODE retcodeTables, retcodeColumns, retcodeStatistics  
  
retcodeTables = SQLGetFunctions(hdbc, SQL_API_SQLTABLES, &TablesExists);  
retcodeColumns = SQLGetFunctions(hdbc, SQL_API_SQLCOLUMNS, &ColumnsExists);  
retcodeStatistics = SQLGetFunctions(hdbc, SQL_API_SQLSTATISTICS, &StatisticsExists);  
  
// SQLGetFunctions is completed successfully and SQLTables, SQLColumns, and SQLStatistics are supported by the driver.  
if (retcodeTables == SQL_SUCCESS && TablesExists == SQL_TRUE &&   
retcodeColumns == SQL_SUCCESS && ColumnsExists == SQL_TRUE &&   
retcodeStatistics == SQL_SUCCESS && StatisticsExists == SQL_TRUE)   
{  
  
   // Continue with application  
  
}  
  
SQLDisconnect(hdbc);  

Nel secondo esempio un'applicazione ODBC 3.x chiama SQLGetFunctions e la passa a una matrice in cui SQLGetFunctions restituisce informazioni su tutte le funzioni ODBC 3.x e precedenti.

RETCODE retcodeTables, retcodeColumns, retcodeStatistics  
SQLUSMALLINT fExists[SQL_API_ODBC3_ALL_FUNCTIONS_SIZE];  
  
retcode = SQLGetFunctions(hdbc, SQL_API_ODBC3_ALL_FUNCTIONS, fExists);  
  
// SQLGetFunctions is completed successfully and SQLTables, SQLColumns, and SQLStatistics are supported by the driver.  
if (retcode == SQL_SUCCESS &&   
SQL_FUNC_EXISTS(fExists, SQL_API_SQLTABLES) == SQL_TRUE &&  
   SQL_FUNC_EXISTS(fExists, SQL_API_SQLCOLUMNS) == SQL_TRUE &&  
   SQL_FUNC_EXISTS(fExists, SQL_API_SQLSTATISTICS) == SQL_TRUE)   
{  
  
   // Continue with application  
  
}  
  
SQLDisconnect(hdbc);  

Il terzo esempio è un'applicazione ODBC 2.x chiama SQLGetFunctions e lo passa a una matrice di 100 elementi in cui SQLGetFunctions restituisce informazioni su tutte le funzioni ODBC 2.x e precedenti.

#define FUNCTIONS 100  
  
RETCODE retcodeTables, retcodeColumns, retcodeStatistics  
SQLUSMALLINT fExists[FUNCTIONS];  
  
retcode = SQLGetFunctions(hdbc, SQL_API_ALL_FUNCTIONS, fExists);  
  
/* SQLGetFunctions is completed successfully and SQLTables, SQLColumns, and SQLStatistics are supported by the driver. */  
if (retcode == SQL_SUCCESS &&   
fExists[SQL_API_SQLTABLES] == SQL_TRUE &&  
   fExists[SQL_API_SQLCOLUMNS] == SQL_TRUE &&  
   fExists[SQL_API_SQLSTATISTICS] == SQL_TRUE)   
{  
  
   /* Continue with application */  
  
}  
  
SQLDisconnect(hdbc);  

Funzioni correlate

Vedi anche

Riferimento API ODBC
File di intestazione ODBC