Dela via


DLL API-referens för installationsprogrammet

gäller för:SQL ServerAzure SQL DatabaseAzure SQL Managed Instance

Installer DLL-API:et innehåller funktioner för programmatisk hantering av ODBC-datakällor, drivrutiner och översättare. Program och installationsprogram använder dessa funktioner för att installera, konfigurera och ta bort ODBC-komponenter och för att hantera registerinformation. Microsoft skriver och omdistribuerar installations-DLL:en.

API:et består av 25 funktioner. Tre av dessa funktioner, SQLGetTranslator, SQLRemoveDSNFromInioch SQLWriteDSNToIni, anropas endast av installations-DLL:er. Installation- och administrationsprogram anropar de andra funktionerna.

Varje funktion är märkt med den version av ODBC som den introducerades i.

Konfiguration av datakälla

Dessa funktioner skapar, ändrar och tar bort ODBC-datakällor programmatiskt. Använd dem när du skapar anpassade installationsprogram eller program som behöver konfigurera datakällans anslutningar utan användarinteraktion.

Funktion Description
SQLConfigDataSource Lägger till, ändrar eller tar bort en datakälla. Anropar drivrutinskonfigurationens DLL för att utföra den faktiska konfigurationen.
SQLCreateDataSource Visar en dialogruta som gör att användare kan lägga till en datakälla interaktivt.
SQLManageDataSources Visar en dialogruta för att hantera datakällor och spårningsalternativ, ungefär som ODBC-datakälladministratören.
SQLValidDSN Kontrollerar längden och giltigheten för ett datakällans namn innan det skrivs till registret.
SQLReadFileDSN Läser anslutningsinformation från ett filbaserat datakällnamn (.dsn-fil).
SQLWriteFileDSN Skriver anslutningsinformation till ett filbaserat datakällnamn (.dsn-fil).
SQLRemoveDefaultDataSource Tar bort standarddatakällan från systeminformationen.

Installation och borttagning av drivrutin

Dessa funktioner installerar och tar bort ODBC-drivrutiner från systemet. De hanterar registerposter och användningsantal för att stödja flera program som delar samma drivrutiner.

Funktion Description
SQLInstallDriverEx Lägger till drivrutinsinformation i registret och ökar antalet drivrutiner. Returnerar målkatalogen för drivrutinsfiler.
SQLInstallDriverManager Returnerar målkatalogen för installation av ODBC-kärnkomponenter. Inaktuell i ODBC 3.0 eftersom Driver Manager är en del av Windows.
SQLRemoveDriver Tar bort drivrutinsinformation från registret. Minskar drivrutinens användningsantal och tar bort registerposter när antalet når noll.
SQLRemoveDriverManager Minskar antalet odbc-kärnkomponenter. Inaktuell eftersom Drivrutinshanteraren nu är en del av Windows.
SQLConfigDriver Läser in en drivrutins installations-DLL och anropar dess ConfigDriver funktion för att utföra drivrutinsspecifika konfigurationsuppgifter.

Installation och borttagning av Translator

Dessa funktioner hanterar ODBC-översättare som konverterar data mellan teckenuppsättningar (till exempel ANSI till Unicode). Använd dem när programmet kräver dataöversättning under kommunikationen med en datakälla.

Funktion Description
SQLInstallTranslatorEx Lägger till translator-information i registret och ökar antalet översättares användning.
SQLInstallTranslator Installerar en översättare. Deprecated; använd SQLInstallTranslatorEx i stället.
SQLRemoveTranslator Tar bort translator-information från registret. Minskar användningsantalet och tar bort poster när antalet når noll.
SQLGetTranslator Visar en dialogruta för att välja en översättare. Anropas av DLL:er för drivrutinskonfiguration för att uppmana användarna att välja översättare.

Register- och konfigurationsverktyg

Dessa funktioner läser och skriver konfigurationsdata i ODBC-avsnittet i Windows-registret. Andra installationsfunktioner och drivrutinsinstallations-DLL:er använder dem internt.

Funktion Description
SQLWriteDSNToIni Lägger till ett namn på datakällan i registret. Anropas av drivrutinsinstallations-DLL:er när du skapar en ny datakälla.
SQLRemoveDSNFromIni Tar bort ett datakällans namn från registret. Anropas av DLL:er för drivrutinskonfiguration när du tar bort en datakälla.
SQLGetPrivateProfileString Läser ett värde från en undernyckel för datakällans specifikation i registret.
SQLWritePrivateProfileString Skriver ett värde till en undernyckel för datakällans specifikation i registret.
SQLGetInstalledDrivers Returnerar en lista över installerade ODBC-drivrutiner från registret.
SQLGetConfigMode Hämtar konfigurationsläget som anger vilken registerplats (användare eller system) som används för datakällans poster.
SQLSetConfigMode Anger konfigurationsläget som anger var datakällans poster skrivs i registret.

Felhantering

Dessa funktioner ger felinformation när installationsfunktioner misslyckas.

Funktion Description
SQLInstallerError Returnerar fel- eller statusinformation för installationsfunktioner. Varje funktion i installations-DLL:en publicerar noll eller fler fel som kan hämtas av den här funktionen.
SQLPostInstallerError Tillåter DLL:er för drivrutinskonfiguration att rapportera fel till installationsfelkön så att SQLInstallerError de kan returneras.