Sdílet prostřednictvím


Referenční informace k rozhraní API knihovny DLL instalačního programu

platí pro: SQL Server Azure SQL DatabaseAzure SQL Managed Instance

Rozhraní API knihovny DLL instalačního programu poskytuje funkce pro programovou správu zdrojů dat ODBC, ovladačů a překladatelů. Aplikace a instalační programy používají tyto funkce k instalaci, konfiguraci a odebrání komponent ODBC a ke správě informací o registru. Microsoft zapisuje a redistribuuje instalační knihovnu DLL.

Rozhraní API se skládá z 25 funkcí. Tři z těchto funkcí, , SQLGetTranslatorSQLRemoveDSNFromInia SQLWriteDSNToIni, jsou volána pouze nastavením knihoven DLL. Programy pro nastavení a správu volají ostatní funkce.

Každá funkce je označená verzí ROZHRANÍ ODBC, ve které byla zavedena.

Konfigurace zdroje dat

Tyto funkce vytvářejí, upravují a odebírat zdroje dat ODBC programově. Používejte je při vytváření vlastních instalačních programů nebo aplikací, které potřebují konfigurovat připojení ke zdroji dat bez zásahu uživatele.

Funkce Description
SQLConfigDataSource Přidá, upraví nebo odstraní zdroj dat. Volá instalační knihovnu DLL ovladače, aby provedl skutečnou konfiguraci.
SQLCreateDataSource Zobrazí dialogové okno, které uživatelům umožňuje interaktivně přidat zdroj dat.
SQLManageDataSources Zobrazí dialogové okno pro správu zdrojů dat a možností trasování, podobně jako správce zdrojů dat ODBC.
SQLValidDSN Před zápisem do registru zkontroluje délku a platnost názvu zdroje dat.
SQLReadFileDSN Čte informace o připojení z názvu zdroje dat založeného na souboru (soubor .dsn).
SQLWriteFileDSN Zapíše informace o připojení do názvu zdroje dat založeného na souboru (soubor .dsn).
SQLRemoveDefaultDataSource Odebere výchozí zdroj dat ze systémových informací.

Instalace a odebrání ovladače

Tyto funkce nainstalují a odeberou ovladače ODBC ze systému. Spravují položky registru a počty využití, aby podporovaly více aplikací sdílejících stejné ovladače.

Funkce Description
SQLInstallDriverEx Přidá informace o ovladači do registru a zvýší počet využití ovladače. Vrátí cílový adresář pro soubory ovladačů.
SQLInstallDriverManager Vrátí cílový adresář pro instalaci základních komponent ODBC. Zastaralé v rozhraní ODBC 3.0, protože Správce ovladačů je součástí Systému Windows.
SQLRemoveDriver Odebere informace o ovladači z registru. Sníží počet využití řidiče a odebere položky registru, když počet dosáhne nuly.
SQLRemoveDriverManager Sníží počet využití základní komponenty ODBC. Zastaralé, protože správce ovladačů je teď součástí Windows.
SQLConfigDriver Načte instalační knihovnu DLL ovladače a zavolá její ConfigDriver funkci k provádění úloh konfigurace specifických pro ovladače.

Instalace a odebrání služby Translator

Tyto funkce spravují překladače ODBC, které převádějí data mezi znakovými sadami (například ANSI na Unicode). Použijte je, když vaše aplikace vyžaduje překlad dat během komunikace se zdrojem dat.

Funkce Description
SQLInstallTranslatorEx Přidá informace o překladateli do registru a zvýší počet využití překladatele.
SQLInstallTranslator Nainstaluje překladatele. Zastaralé; místo toho použijte SQLInstallTranslatorEx .
SQLRemoveTranslator Odebere informace o překladateli z registru. Sníží počet využití a odebere položky, když počet dosáhne nuly.
SQLGetTranslator Zobrazí dialogové okno pro výběr překladače. Volá se knihovnou DLL pro nastavení ovladače, která uživatele vyzve k výběru překladače.

Nástroje registru a konfigurace

Tyto funkce čtou a zapisují konfigurační data v části ODBC registru Systému Windows. Další instalační funkce a instalační knihovny DLL ovladačů je používají interně.

Funkce Description
SQLWriteDSNToIni Přidá název zdroje dat do registru. Volá se při vytváření nového zdroje dat knihovnou DLL pro nastavení ovladače.
SQLRemoveDSNFromIni Odebere název zdroje dat z registru. Volá se instalační knihovny DLL ovladače při odstraňování zdroje dat.
SQLGetPrivateProfileString Načte hodnotu z podklíče specifikace zdroje dat v registru.
SQLWritePrivateProfileString Zapíše hodnotu do podklíče specifikace zdroje dat v registru.
SQLGetInstalledDrivers Vrátí seznam nainstalovaných ovladačů ODBC z registru.
SQLGetConfigMode Načte režim konfigurace, který označuje, které umístění registru (uživatel nebo systém) se používá pro položky zdroje dat.
SQLSetConfigMode Nastaví režim konfigurace, který označuje, kde jsou položky zdroje dat zapsány v registru.

Zpracování chyb

Tyto funkce poskytují informace o chybách při selhání funkcí instalačního programu.

Funkce Description
SqlInstallerError Vrátí informace o chybě nebo stavu pro funkce instalačního programu. Každá funkce v instalační knihovně DLL publikuje nula nebo více chyb, které lze načíst touto funkcí.
SQLPostInstallerError Umožňuje knihovnám DLL instalačního programu oznamovat chyby ve frontě chyb instalačního programu, aby SQLInstallerError je mohly vrátit.