Bagikan melalui


Referensi API DLL alat penginstal

Berlaku untuk:SQL ServerAzure SQL DatabaseAzure SQL Managed Instance

INSTALLER DLL API menyediakan fungsi untuk manajemen terprogram sumber data ODBC, driver, dan penerjemah. Aplikasi dan program penyiapan menggunakan fungsi ini untuk menginstal, mengonfigurasi, dan menghapus komponen ODBC, dan untuk mengelola informasi registri. Microsoft menulis dan mendistribusikan ulang DLL Penginstal.

API terdiri dari 25 fungsi. Tiga fungsi ini, , SQLGetTranslator, SQLRemoveDSNFromInidan SQLWriteDSNToIni, hanya dipanggil dengan menyiapkan DLL. Program penyetelan dan administrasi memanggil fungsi lainnya.

Setiap fungsi diberi label dengan versi ODBC tempat fungsi diperkenalkan.

Konfigurasi sumber data

Fungsi-fungsi ini membuat, memodifikasi, dan menghapus sumber data ODBC secara terprogram. Gunakan saat membangun program atau aplikasi penyiapan kustom yang perlu mengonfigurasi koneksi sumber data tanpa interaksi pengguna.

Function Description
SQLConfigDataSource Menambahkan, memodifikasi, atau menghapus sumber data. Memanggil DLL penyetelan driver untuk melakukan konfigurasi aktual.
SQLCreateDataSource Menampilkan kotak dialog yang memungkinkan pengguna menambahkan sumber data secara interaktif.
SQLManageDataSources Menampilkan kotak dialog untuk mengelola sumber data dan opsi pelacakan, mirip dengan Administrator Sumber Data ODBC.
SQLValidDSN Memeriksa panjang dan validitas nama sumber data sebelum ditulis ke registri.
SQLReadFileDSN Membaca informasi koneksi dari nama sumber data berbasis file (file.dsn).
SQLWriteFileDSN Menulis informasi koneksi ke nama sumber data berbasis file (file.dsn).
SQLRemoveDefaultDataSource Menghapus sumber data default dari informasi sistem.

Penginstalan dan penghapusan driver

Fungsi-fungsi ini menginstal dan menghapus driver ODBC dari sistem. Mereka mengelola entri registri dan jumlah penggunaan untuk mendukung beberapa aplikasi yang berbagi driver yang sama.

Function Description
SQLInstallDriverEx Menambahkan informasi driver ke registri dan menambah jumlah penggunaan driver. Mengembalikan direktori target untuk file driver.
SQLInstallDriverManager Mengembalikan direktori target untuk menginstal komponen inti ODBC. Tidak digunakan lagi di ODBC 3.0 karena Driver Manager adalah bagian dari Windows.
SQLRemoveDriver Menghapus informasi driver dari registri. Mengurangi jumlah penggunaan driver dan menghapus entri registri ketika hitungan mencapai nol.
SQLRemoveDriverManager Mengurangi jumlah penggunaan komponen inti ODBC. Tidak digunakan lagi karena Manajer Driver sekarang menjadi bagian dari Windows.
SQLConfigDriver Memuat DLL penyiapan driver dan memanggil fungsinya ConfigDriver untuk melakukan tugas konfigurasi khusus driver.

Penginstalan dan penghapusan penerjemah

Fungsi-fungsi ini mengelola penerjemah ODBC, yang mengonversi data antara kumpulan karakter (misalnya, ANSI ke Unicode). Gunakan saat aplikasi Anda memerlukan terjemahan data selama komunikasi dengan sumber data.

Function Description
SQLInstallTranslatorEx Menambahkan informasi penerjemah ke registri dan menambah jumlah penggunaan penerjemah.
SQLInstallTranslator Menginstal penerjemah. Usang; gunakan SQLInstallTranslatorEx sebagai gantinya.
SQLRemoveTranslator Menghapus informasi penerjemah dari registri. Mengurangi jumlah penggunaan dan menghapus entri ketika jumlah mencapai nol.
SQLGetTranslator Menampilkan kotak dialog untuk memilih penerjemah. Dipanggil oleh DLL penyiapan driver untuk meminta pengguna untuk pemilihan penerjemah.

Utilitas registri dan konfigurasi

Fungsi-fungsi ini membaca dan menulis data konfigurasi di bagian ODBC dari registri Windows. Fungsi penginstal lainnya dan DLL penyiapan driver menggunakannya secara internal.

Function Description
SQLWritedsnToIni Menambahkan nama sumber data ke registri. Dipanggil oleh DLL penyiapan driver saat membuat sumber data baru.
SQLRemovedsnFromIni Menghapus nama sumber data dari registri. Dipanggil oleh DLL penyiapan driver saat menghapus sumber data.
SQLGetPrivateProfileString Membaca nilai dari subkunjuk spesifikasi sumber data dalam registri.
SQLWritePrivateProfileString Menulis nilai ke subkuntang spesifikasi sumber data dalam registri.
SQLGetInstalledDrivers Mengembalikan daftar driver ODBC yang diinstal dari registri.
SQLGetConfigMode Mengambil mode konfigurasi yang menunjukkan lokasi registri mana (pengguna atau sistem) yang digunakan untuk entri sumber data.
SQLSetConfigMode Mengatur mode konfigurasi yang menunjukkan tempat entri sumber data ditulis dalam registri.

Penanganan kesalahan

Fungsi-fungsi ini memberikan informasi kesalahan ketika fungsi penginstal gagal.

Function Description
SQLInstallerError Mengembalikan informasi kesalahan atau status untuk fungsi penginstal. Setiap fungsi dalam DLL Penginstal memposting nol atau lebih kesalahan yang dapat diambil oleh fungsi ini.
SQLPostInstallerError Memungkinkan DLL penyetelan driver untuk melaporkan kesalahan ke antrean kesalahan penginstal sehingga SQLInstallerError dapat mengembalikannya.