Funzione SQLDataSources

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

Riepilogo
SQLDataSources restituisce informazioni su un'origine dati. Questa funzione viene implementata solo da Gestione driver.

Sintassi

  
SQLRETURN SQLDataSources(  
     SQLHENV          EnvironmentHandle,  
     SQLUSMALLINT     Direction,  
     SQLCHAR *        ServerName,  
     SQLSMALLINT      BufferLength1,  
     SQLSMALLINT *    NameLength1Ptr,  
     SQLCHAR *        Description,  
     SQLSMALLINT      BufferLength2,  
     SQLSMALLINT *    NameLength2Ptr);  

Argomenti

EnvironmentHandle
[Input] Handle dell'ambiente.

Direzione
[Input] Determina l'origine dati su cui Gestione driver restituisce informazioni. I possibili valori sono i seguenti:

SQL_FETCH_NEXT (per recuperare il nome dell'origine dati successiva nell'elenco), SQL_FETCH_FIRST (da recuperare dall'inizio dell'elenco), SQL_FETCH_FIRST_USER (per recuperare il primo DSN utente) o SQL_FETCH_FIRST_SYSTEM (per recuperare il primo DSN di sistema).

Quando Direction è impostato su SQL_FETCH_FIRST, le chiamate successive a SQLDataSources con Direction impostata su SQL_FETCH_NEXT restituiscono DSN utente e di sistema. Quando Direction è impostato su SQL_FETCH_FIRST_USER, tutte le chiamate successive a SQLDataSources con Direction impostato su SQL_FETCH_NEXT restituiscono solo DSN utente. Quando Direction è impostato su SQL_FETCH_FIRST_SYSTEM, tutte le chiamate successive a SQLDataSources con Direction impostata su SQL_FETCH_NEXT restituiscono solo DSN di sistema.

ServerName
[Output] Puntatore a un buffer in cui restituire il nome dell'origine dati.

Se ServerName è NULL, NameLength1Ptr restituirà comunque il numero totale di caratteri (escluso il carattere di terminazione Null per i dati di tipo carattere) da restituire nel buffer a cui punta ServerName.

BufferLength1
[Input] Lunghezza del buffer *ServerName , in caratteri; questo non deve essere più lungo di SQL_MAX_DSN_LENGTH più il carattere di terminazione Null.

NameLength1Ptr
[Output] Puntatore a un buffer in cui restituire il numero totale di caratteri (escluso il carattere di terminazione Null) disponibile per la restituzione in *ServerName. Se il numero di caratteri disponibili per la restituzione è maggiore o uguale a BufferLength1, il nome dell'origine dati in *ServerName viene troncato a BufferLength1 meno la lunghezza di un carattere di terminazione Null.

Descrizione
[Output] Puntatore a un buffer in cui restituire la descrizione del driver associato all'origine dati. Ad esempio, dBASE o SQL Server.

Se Description è NULL, NameLength2Ptr restituirà comunque il numero totale di caratteri (escluso il carattere di terminazione Null per i dati di tipo carattere) da restituire nel buffer a cui punta Descrizione.

BufferLength2
[Input] Lunghezza in caratteri del buffer *Description .

NameLength2Ptr
[Output] Puntatore a un buffer in cui restituire il numero totale di caratteri (escluso il carattere di terminazione Null) disponibile per la restituzione in *Descrizione. Se il numero di caratteri disponibili per la restituzione è maggiore o uguale a BufferLength2, la descrizione del driver in *Description viene troncata a BufferLength2 meno la lunghezza di un carattere di terminazione Null.

Resi

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_NO_DATA, SQL_ERROR o SQL_INVALID_HANDLE.

Diagnostica

Quando SQLDataSources restituisce SQL_ERROR o SQL_SUCCESS_WITH_INFO, è possibile ottenere un valore SQLSTATE associato chiamando SQLGetDiagRec con handleTypedi SQL_HANDLE_ENV e handle di EnvironmentHandle. La tabella seguente elenca i valori SQLSTATE restituiti in genere da SQLDataSources e ne spiega ognuno 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

Poiché SQLDataSources viene implementato in Gestione driver, è supportato per tutti i driver indipendentemente dalla conformità degli standard di un determinato driver.

Un'applicazione può chiamare SQLDataSources più volte per recuperare tutti i nomi delle origini dati. Gestione driver recupera queste informazioni dalle informazioni di sistema. Quando non sono presenti più nomi di origine dati, Gestione driver restituisce SQL_NO_DATA. Se SQLDataSources viene chiamato con SQL_FETCH_NEXT immediatamente dopo che restituisce SQL_NO_DATA, restituirà il primo nome dell'origine dati. Per informazioni su come un'applicazione usa le informazioni restituite da SQLDataSources, vedere Scelta di un'origine dati o di un driver.

Se SQL_FETCH_NEXT viene passato a SQLDataSources la prima volta che viene chiamato, restituirà il primo nome dell'origine dati.

Il driver determina il mapping dei nomi delle origini dati alle origini dati effettive.

Funzioni correlate

Vedi anche

Riferimento API ODBC
File di intestazione ODBC