Bagikan melalui

Fungsi SQLGetPrivateProfileString

  • Artikel

Kesesuaian
Versi diperkenalkan: ODBC 2.0

Ringkasan
SQLGetPrivateProfileString mendapatkan daftar nama nilai atau data yang sesuai dengan nilai informasi sistem.

Sintaks

  
int SQLGetPrivateProfileString(  
     LPCSTR   lpszSection,  
     LPCSTR   lpszEntry,  
     LPCSTR   lpszDefault,  
     LPCSTR   RetBuffer,  
     INT      cbRetBuffer,  
     LPCSTR   lpszFilename);

Argumen

lpszSection
[Input] Menunjuk ke string null-terminated yang menentukan bagian yang berisi nama kunci. Jika argumen ini adalah NULL, fungsi menyalin semua nama bagian dalam file ke buffer yang disediakan.

lpszEntry
[Input] Menunjuk ke string null-terminated yang berisi nama kunci yang string terkait akan diambil. Jika argumen ini NULL, semua nama kunci di bagian yang ditentukan oleh argumen lpszSection disalin ke buffer yang ditentukan oleh argumen RetBuffer .

lpszDefault
[Input] Menunjuk ke string null-terminated yang menentukan nilai default untuk kunci yang diberikan jika kunci tidak dapat ditemukan dalam file inisialisasi. Argumen ini tidak boleh NULL.

RetBuffer
[Output] Menunjuk ke buffer yang menerima string yang diambil.

cbRetBuffer
[Input] Menentukan ukuran, dalam karakter, dari buffer yang ditujukkan oleh argumen RetBuffer .

lpszFilename
[Input] Menunjuk ke string null-terminated yang menamai file inisialisasi. Jika argumen ini tidak berisi jalur lengkap ke file, direktori default akan dicari.

Mengembalikan

SQLGetPrivateProfileString mengembalikan nilai bilangan bulat yang menunjukkan jumlah karakter yang dibaca.

Diagnostik

Ketika panggilan ke SQLGetPrivateProfileString gagal, 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_OUT_OF_MEM Kehabisan memori Alat penginstal tidak dapat melakukan fungsi karena kurangnya memori.

Komentar

SQLGetPrivateProfileString disediakan sebagai cara sederhana untuk port driver dan DRIVER setup DLL dari Microsoft Windows ke Microsoft Windows NT/Windows 2000. Panggilan ke GetPrivateProfileString yang mengambil string profil dari file Odbc.ini harus diganti dengan panggilan ke SQLGetPrivateProfileString. SQLGetPrivateProfileString memanggil fungsi di API Win32 untuk mengambil nama nilai atau data yang diminta yang sesuai dengan nilai subkuntah Odbc.ini informasi sistem.

Mode konfigurasi (sebagaimana diatur oleh SQLSetConfigMode) menunjukkan di mana entri Odbc.ini yang mencantumkan nilai DSN berada dalam informasi sistem. Jika DSN adalah DSN Pengguna (mode konfigurasi USERDSN_ONLY), fungsi membaca dari entri Odbc.ini di HKEY_CURRENT_USER. Jika DSN adalah DSN Sistem (SYSTEMDSN_ONLY), fungsi membaca dari entri Odbc.ini di HKEY_LOCAL_MACHINE. Jika mode konfigurasi adalah BOTHDSN, HKEY_CURRENT_USER dicoba, dan jika gagal, HKEY_LOCAL_MACHINE digunakan.

Untuk informasi tentang Lihat
Menulis nilai ke informasi sistem SQLWritePrivateProfileString