Fungsi SQLConfigDataSource

Kesesuaian
Versi Diperkenalkan: ODBC 1.0

Ringkasan
SQLConfigDataSource menambahkan, memodifikasi, atau menghapus sumber data.

Fungsionalitas SQLConfigDataSource juga dapat diakses dengan ODBCCONF.EXE.

Sintaks

  
BOOL SQLConfigDataSource(  
     HWND     hwndParent,  
     WORD     fRequest,  
     LPCSTR   lpszDriver,  
     LPCSTR   lpszAttributes);  

Argumen

hwndParent
[Input] Handel jendela induk. Fungsi tidak akan menampilkan kotak dialog apa pun jika handel null.

fRequest
[Input] Jenis permintaan. Argumen fRequest harus berisi salah satu nilai berikut:

ODBC_ADD_DSN: Tambahkan sumber data pengguna baru.

ODBC_CONFIG_DSN: Mengonfigurasi (memodifikasi) sumber data pengguna yang sudah ada.

ODBC_REMOVE_DSN: Hapus sumber data pengguna yang sudah ada.

ODBC_ADD_SYS_DSN: Tambahkan sumber data sistem baru.

ODBC_CONFIG_SYS_DSN: Mengubah sumber data sistem yang ada.

ODBC_REMOVE_SYS_DSN: Hapus sumber data sistem yang ada.

ODBC_REMOVE_DEFAULT_DSN: Hapus bagian spesifikasi sumber data default dari informasi sistem. (Ini juga menghapus bagian spesifikasi driver default dari entri Odbcinst.ini dalam informasi sistem. fRequest ini melakukan fungsi yang sama dengan fungsi SQLRemoveDefaultDataSource yang tidak digunakan lagi.) Ketika opsi ini ditentukan, semua parameter lain dalam panggilan ke SQLConfigDataSource harus NULL; jika tidak NULL, parameter tersebut akan diabaikan.

lpszDriver
[Input] Deskripsi driver (biasanya nama DBMS terkait) yang disajikan kepada pengguna alih-alih nama driver fisik.

lpszAttributes
[Input] Daftar atribut dua kali dihentikan null dalam bentuk pasangan kata kunci-nilai. Untuk informasi selengkapnya, lihat ConfigDSN.

Kembali

Fungsi mengembalikan TRUE jika berhasil, FALSE jika gagal. Jika tidak ada entri dalam informasi sistem ketika fungsi ini dipanggil, fungsi mengembalikan FALSE.

Diagnostik

Ketika SQLConfigDataSource 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_HWND Handel jendela tidak valid Argumen hwndParent tidak valid atau NULL.
ODBC_ERROR_INVALID_REQUEST_TYPE Jenis permintaan tidak valid Argumen fRequest bukan salah satu dari berikut ini:

ODBC_ADD_DSN ODBC_CONFIG_DSN ODBC_REMOVE_DSN ODBC_ADD_SYS_DSN ODBC_CONFIG_SYS_DSN ODBC_REMOVE_SYS_DSN ODBC_REMOVE_DEFAULT_DSN
ODBC_ERROR_INVALID_NAME Nama pengandar atau penerjemah tidak valid Argumen lpszDriver tidak valid. Ini tidak dapat ditemukan di registri.
ODBC_ERROR_INVALID_KEYWORD_VALUE Pasangan nilai kata kunci tidak valid Argumen lpszAttributes berisi kesalahan sintaks.
ODBC_ERROR_REQUEST_FAILED Permintaan gagal Alat penginstal tidak dapat melakukan operasi yang diminta oleh argumen fRequest . Panggilan ke ConfigDSN gagal.
ODBC_ERROR_LOAD_LIBRARY_FAILED Tidak dapat memuat pustaka penyetelan pengandar atau penerjemah Pustaka penyetelan driver tidak dapat dimuat.
ODBC_ERROR_OUT_OF_MEM Kehabisan memori Alat penginstal tidak dapat melakukan fungsi karena kurangnya memori.

Komentar

SQLConfigDataSource menggunakan nilai lpszDriver untuk membaca jalur lengkap DLL penyiapan untuk driver dari informasi sistem. Ini memuat DLL dan memanggil ConfigDSN dengan argumen yang sama yang diteruskan ke dalamnya.

SQLConfigDataSource mengembalikan FALSE jika tidak dapat menemukan atau memuat DLL penyiapan atau jika pengguna membatalkan kotak dialog. Jika tidak, ia mengembalikan status yang diterimanya dari ConfigDSN.

SQLConfigDataSource memetakan fRequestDSN Sistem ke fRequestDSN Pengguna (ODBC_ADD_SYS_DSN ke ODBC_ADD_DSN, ODBC_CONFIG_SYS_DSN ke ODBC_CONFIG_DSN, dan ODBC_REMOVE_SYS_DSN ke ODBC_REMOVE_DSN). Untuk membedakan pengguna dan DSN Sistem, SQLConfigDataSource mengatur mode konfigurasi penginstal sesuai dengan tabel berikut. Sebelum kembali, SQLConfigDataSource mengatur ulang mode konfigurasi ke BOTHDSN. ConfigDSN (diimplementasikan oleh driver) harus memanggil SQLWriteDSNToIni dan SQLWritePrivateProfileString untuk mendukung DSN sistem. Untuk informasi selengkapnya, lihat Fungsi ConfigDSN.

fRequest Mode konfigurasi
ODBC_ADD_DSN USERDSN_ONLY
ODBC_CONFIG_DSN USERDSN_ONLY
ODBC_REMOVE_DSN USERDSN_ONLY
ODBC_ADD_SYS_DSN SYSTEMDSN_ONLY
ODBC_CONFIG_SYS_DSN SYSTEMDSN_ONLY
ODBC_REMOVE_SYS_DSN SYSTEMDSN_ONLY
Untuk informasi tentang Lihat
Menambahkan, memodifikasi, atau menghapus sumber data ConfigDSN (dalam DLL penyiapan)
Menghapus nama sumber data dari informasi sistem SQLRemovedsnFromIni
Menambahkan nama sumber data ke informasi sistem SQLWritedsnToIni