Udostępnij przez


Dokumentacja interfejsu API bibliotek DLL instalatora

Dotyczy:SQL ServerAzure SQL DatabaseAzure SQL Managed Instance

Interfejs API dll Instalatora udostępnia funkcje programowego zarządzania źródłami danych, sterownikami i tłumaczami ODBC. Aplikacje i programy instalacyjne używają tych funkcji do instalowania, konfigurowania i usuwania składników ODBC oraz zarządzania informacjami rejestru. Firma Microsoft zapisuje i redystrybuuje bibliotekę DLL Instalatora.

Interfejs API składa się z 25 funkcji. Trzy z tych funkcji, SQLGetTranslator, SQLRemoveDSNFromInii SQLWriteDSNToIni, są wywoływane tylko przez biblioteki DLL konfiguracji. Programy instalacyjne i administracyjne nazywają inne funkcje.

Każda funkcja jest oznaczona etykietą z wersją ODBC, w której została wprowadzona.

Konfiguracja źródła danych

Te funkcje tworzą, modyfikują i usuwają programowo źródła danych ODBC. Używaj ich podczas tworzenia niestandardowych programów instalacyjnych lub aplikacji, które muszą konfigurować połączenia ze źródłem danych bez interakcji użytkownika.

Funkcja Description
SQLConfigDataSource Dodaje, modyfikuje lub usuwa źródło danych. Wywołuje bibliotekę DLL konfiguracji sterownika, aby wykonać rzeczywistą konfigurację.
SQLCreateDataSource Wyświetla okno dialogowe umożliwiające użytkownikom interaktywne dodawanie źródła danych.
SQLManageDataSources Wyświetla okno dialogowe do zarządzania źródłami danych i opcjami śledzenia, podobnie jak administrator źródła danych ODBC.
SQLValidDSN Sprawdza długość i ważność nazwy źródła danych przed zapisaniem jej w rejestrze.
SQLReadFileDSN Odczytuje informacje o połączeniu z nazwy źródła danych opartego na pliku (plik dsn).
SQLWriteFileDSN Zapisuje informacje o połączeniu z nazwą źródła danych opartego na pliku (plik dsn).
SQLRemoveDefaultDataSource Usuwa domyślne źródło danych z informacji systemowych.

Instalacja i usuwanie sterownika

Te funkcje instalują i usuwają sterowniki ODBC z systemu. Zarządzają wpisami rejestru i liczbami użycia w celu obsługi wielu aplikacji współużytkowania tych samych sterowników.

Funkcja Description
SQLInstallDriverEx Dodaje informacje o sterowniku do rejestru i zwiększa liczbę użycia sterownika. Zwraca katalog docelowy dla plików sterowników.
SQLInstallDriverManager Zwraca katalog docelowy do instalowania podstawowych składników ODBC. Przestarzałe w wersji ODBC 3.0, ponieważ menedżer sterowników jest częścią systemu Windows.
SQLRemoveDriver Usuwa informacje o sterownikach z rejestru. Dekrementuje liczbę użycia sterownika i usuwa wpisy rejestru, gdy liczba osiągnie zero.
SQLRemoveDriverManager Dekrementuje liczbę użycia składnika podstawowego ODBC. Przestarzałe, ponieważ menedżer sterowników jest teraz częścią systemu Windows.
SQLConfigDriver Ładuje bibliotekę DLL konfiguracji sterownika i wywołuje jego ConfigDriver funkcję w celu wykonywania zadań konfiguracyjnych specyficznych dla sterownika.

Instalacja i usuwanie w usłudze Translator

Te funkcje zarządzają translatorami ODBC, które konwertują dane między zestawami znaków (na przykład ANSI na Unicode). Używaj ich, gdy aplikacja wymaga tłumaczenia danych podczas komunikacji ze źródłem danych.

Funkcja Description
SQLInstallTranslatorEx Dodaje informacje w usłudze Translator do rejestru i zwiększa liczbę użycia tłumacza.
SQLInstallTranslator Instaluje tłumacza. Przestarzałe; Zamiast tego użyj SQLInstallTranslatorEx polecenia .
SQLRemoveTranslator Usuwa informacje translatora z rejestru. Dekrementuje liczbę użycia i usuwa wpisy, gdy liczba osiągnie zero.
SQLGetTranslator Wyświetla okno dialogowe wybierania tłumacza. Wywoływane przez biblioteki DLL konfiguracji sterowników w celu monitowania użytkowników o wybór tłumacza.

Narzędzia rejestru i konfiguracji

Te funkcje odczytują i zapisują dane konfiguracji w sekcji ODBC rejestru systemu Windows. Inne funkcje instalatora i biblioteki DLL konfiguracji sterowników używają ich wewnętrznie.

Funkcja Description
SQLWriteDSNToIni Dodaje nazwę źródła danych do rejestru. Wywoływane przez biblioteki DLL konfiguracji sterowników podczas tworzenia nowego źródła danych.
SQLRemoveDSNFromIni Usuwa nazwę źródła danych z rejestru. Wywoływane przez biblioteki DLL konfiguracji sterowników podczas usuwania źródła danych.
SQLGetPrivateProfileString Odczytuje wartość z podklucza specyfikacji źródła danych w rejestrze.
SQLWritePrivateProfileString Zapisuje wartość w podkluczu specyfikacji źródła danych w rejestrze.
SQLGetInstalledDrivers Zwraca listę zainstalowanych sterowników ODBC z rejestru.
SQLGetConfigMode Pobiera tryb konfiguracji wskazujący, która lokalizacja rejestru (użytkownik lub system) jest używana dla wpisów źródła danych.
SQLSetConfigMode Ustawia tryb konfiguracji wskazujący, gdzie wpisy źródła danych są zapisywane w rejestrze.

Obsługa błędów

Te funkcje udostępniają informacje o błędach, gdy funkcje instalatora kończą się niepowodzeniem.

Funkcja Description
SQLInstallerError Zwraca informacje o błędzie lub stanie dla funkcji instalatora. Każda funkcja w bibliotece DLL Instalatora publikuje zero lub więcej błędów, które można pobrać przez tę funkcję.
SQLPostInstallerError Umożliwia skonfigurowanie bibliotek DLL konfiguracji sterowników w celu zgłaszania błędów do kolejki błędów instalatora, dzięki SQLInstallerError czemu mogą je zwracać.