Fungsi SQLGetInstalledDrivers

Kesesuaian
Versi Diperkenalkan: ODBC 1.0

Ringkasan
SQLGetInstalledDrivers membaca bagian [Driver ODBC] dari informasi sistem dan mengembalikan daftar deskripsi driver yang diinstal.

Sintaks

  
BOOL SQLGetInstalledDrivers(  
     LPSTR   lpszBuf,  
     WORD    cbBufMax,  
     WORD *  pcbBufOut);  

Argumen

lpszBuf
[Output] Daftar deskripsi driver yang diinstal. Untuk informasi tentang struktur daftar, lihat "Komentar."

cbBufMax
[Input] Panjang lpszBuf.

pcbBufOut
[Output] Jumlah total byte (tidak termasuk byte penghentian null) yang dikembalikan dalam lpszBuf. Jika jumlah byte yang tersedia untuk dikembalikan lebih besar dari atau sama dengan cbBufMax, daftar deskripsi driver di lpszBuf dipotong menjadi cbBufMax dikurangi karakter penghentian null. Argumen pcbBufOut dapat berupa pointer null.

Kembali

Fungsi mengembalikan TRUE jika berhasil, FALSE jika gagal.

Diagnostik

Saat SQLGetInstalledDrivers mengembalikan FALSE, nilai *pfErrorCode terkait dapat diperoleh dengan memanggil SQLInstallerError. Tabel berikut mencantumkan nilai *pfErrorCode yang dapat dikembalikan oleh SQLInstallerError dan menjelaskan masing-masing nilai dalam konteks fungsi ini.

*pfErrorCode	Kesalahan	Deskripsi
ODBC_ERROR_GENERAL_ERR	Kesalahan penginstal umum	Terjadi kesalahan karena tidak ada kesalahan penginstal tertentu.
ODBC_ERROR_INVALID_BUFF_LEN	Panjang buffer tidak valid	Argumen lpszBuf adalah NULL atau tidak valid, atau argumen cbBufMax kurang dari atau sama dengan 0.
ODBC_ERROR_COMPONENT_NOT_FOUND	Komponen tidak ditemukan dalam registri	Alat penginstal tidak dapat menemukan bagian [Driver ODBC] di registri.
ODBC_ERROR_OUT_OF_MEM	Kehabisan memori	Alat penginstal tidak dapat melakukan fungsi karena kurangnya memori.

Komentar

Setiap deskripsi driver dihentikan dengan byte null, dan seluruh daftar dihentikan dengan byte null. (Artinya, dua byte null menandai akhir daftar.) Jika buffer yang dialokasikan tidak cukup besar untuk menahan seluruh daftar, daftar dipotong tanpa kesalahan. Kesalahan dikembalikan jika pointer null diteruskan sebagai lpszBuf.

Fungsi Terkait

Untuk informasi tentang	Lihat
Mengembalikan deskripsi dan atribut driver	SQLDrivers