SQLDataSources-funktion

Överensstämmelse
Version introducerad: ODBC 1.0 Standardefterlevnad: ISO 92

Summary
SQLDataSources returnerar information om en datakälla. Denna funktion implementeras endast av Driver Manager.

Syntax

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

Arguments

EnvironmentHandle
[Input] Miljöhantering.

Riktning
[Input] Avgör vilken datakälla Driver Manager returnerar information om. Kan vara:

SQL_FETCH_NEXT (för att hämta nästa datakälla i listan), SQL_FETCH_FIRST (hämta från början av listan), SQL_FETCH_FIRST_USER (hämta den första användarens DSN) eller SQL_FETCH_FIRST_SYSTEM (för att hämta det första system-DSN).

När Direction är inställt på SQL_FETCH_FIRST returnerar efterföljande anrop till SQLDataSources med Direction satt till SQL_FETCH_NEXT både användar- och system-DSN. När Direction är inställt på SQL_FETCH_FIRST_USER returnerar alla efterföljande anrop till SQLDataSources med Direction satt till SQL_FETCH_NEXT endast användar-DSN. När Direction är inställt på SQL_FETCH_FIRST_SYSTEM returnerar alla efterföljande anrop till SQLDataSources med Direction satt till SQL_FETCH_NEXT endast system-DSN.

ServerName
[Utdata] Peka till en buffert där datakällnamnet ska returneras.

Om ServerName är NULL kommer NameLength1Ptr ändå att returnera det totala antalet tecken (exklusive null-termineringstecken för teckendata) som finns tillgängliga att returnera i bufferten som ServerName pekar på.

BufferLength1
[Input] Längden på *ServerName-bufferten , i tecken; detta behöver inte vara längre än SQL_MAX_DSN_LENGTH plus tecknet null-termination.

NameLength1Ptr
[Utdata] Pekare till en buffert där det totala antalet tecken (exklusive null-termineringstecknet) kan returneras i *ServerName. Om antalet tecken som kan returneras är större än eller lika med BufferLength1, förkortas datakällnamnet i *ServerName till BufferLength1 minus längden på ett null-termineringstecken.

Beskrivning
[Utdata] Peka till en buffert där beskrivningen av drivrutinen kopplad till datakällan ska returneras. Till exempel dBASE eller SQL Server.

Om Beskrivningen är NULL kommer NameLength2Ptr ändå att returnera det totala antalet tecken (exklusive null-termineringstecknet för teckendata) som finns tillgängliga att returnera i bufferten som Beskrivning pekar på.

BufferLength2
[Input] Längd i tecken i *Description-bufferten .

NameLength2Ptr
[Utdata] Pekare till en buffert där det totala antalet tecken (exklusive null-termineringstecknet) kan returneras i *Beskrivning. Om antalet tecken som kan returneras är större än eller lika med BufferLength2, förkortas drivrutinsbeskrivningen i *Description till BufferLength2 minus längden på ett null-termineringstecken.

Returns

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_NO_DATA, SQL_ERROR eller SQL_INVALID_HANDLE.

Diagnostics

När SQLDataSources returnerar antingen SQL_ERROR eller SQL_SUCCESS_WITH_INFO kan ett associerat SQLSTATE-värde erhållas genom att anropa SQLGetDiagRec med HandleType SQL_HANDLE_ENV och Handle EnvironmentHandle. Följande tabell listar de SQLSTATE-värden som vanligtvis returneras av SQLDataSources och förklarar var och en i kontexten av denna funktion; notationen "(DM)" föregår beskrivningarna av SQLSTATE som returneras av Driver Manager. Returkoden som är associerad med varje SQLSTATE-värde är SQL_ERROR, om inget annat anges.

Comments

Eftersom SQLDataSources är implementerat i Driver Manager stöds det för alla drivrutiner oavsett om en viss drivrutin uppfyller standarderna.

En applikation kan anropa SQLDataSources flera gånger för att hämta alla namn på datakällor. Driver Manager hämtar denna information från systeminformationen. När det inte finns några fler namn på datakällor returnerar Driver Manager SQL_NO_DATA. Om SQLDataSources anropas med SQL_FETCH_NEXT omedelbart efter att SQL_NO_DATA returnerats, kommer det att returnera det första datakällnamnet. För information om hur en applikation använder informationen som returneras av SQLDataSources, se Välj en datakälla eller drivrutin.

Om SQL_FETCH_NEXT skickas till SQLDataSources första gången den anropas, returneras det första datakällsnamnet.

Drivrutinen avgör hur datakällsnamn mappas till faktiska datakällor.

Relaterade funktioner

Relaterat innehåll

• ODBC API-referens
• ODBC-huvudfiler