Bagikan melalui

Fungsi SQLReadFileDSN

  • Artikel

Kesesuaian
Versi diperkenalkan: ODBC 3.0

Ringkasan
SQLReadFileDSN membaca informasi dari File DSN.

Sintaks

  
BOOL SQLReadFileDSN(  
     LPCSTR   lpszFileName,  
     LPCSTR   lpszAppName,  
     LPCSTR   lpszKeyName,  
     LPSTR    lpszString,  
     WORD     cbString,  
     WORD *   pcbString);

Argumen

lpszFileName
[Input] Penunjuk ke buffer data yang berisi nama file .dsn. Ekstensi .dsn ditambahkan ke semua nama file yang belum memiliki ekstensi .dsn. Nilai dalam *lpszFileName harus berupa string null-terminated.

lpszAppName
[Input] Penunjuk ke buffer data yang berisi nama aplikasi. Ini adalah "ODBC" untuk bagian ODBC. Nilai dalam *lpszAppName harus berupa string null-terminated.

lpszKeyName
[Input] Penunjuk ke buffer data yang berisi nama kunci yang akan dibaca. Lihat "Komentar" untuk kata kunci yang dipesan. Nilai dalam *lpszAppName harus berupa string null-terminated.

lpszString
[Output] Penunjuk ke buffer data yang berisi string yang terkait dengan kunci yang akan dibaca.

Jika *lpszFileName adalah nama file .dsn yang valid tetapi argumen lpszAppName adalah penunjuk null dan argumen lpszKeyName adalah penunjuk null, maka *lpszString berisi daftar aplikasi yang valid. Jika *lpszFileName adalah nama file .dsn yang valid dan *lpszAppName adalah nama aplikasi yang valid, tetapi argumen lpszKeyName adalah penunjuk null, maka *lpszString berisi daftar kata kunci yang dipesan yang valid di bagian yang sesuai dari file DSN, yang dibatasi oleh titik koma. Jika *lpszFileName adalah nama file .dsn yang valid tetapi *lpszAppName adalah pointer null dan argumen lpszKeyName adalah pointer null, maka *lpszString berisi daftar bagian dalam file DSN, yang dibatasi oleh titik koma.

cbString
[Input] Panjang *buffer lpszString .

pcbString
[Output] Jumlah total byte yang tersedia untuk dikembalikan dalam *lpszString. Jika jumlah byte yang tersedia untuk dikembalikan lebih besar dari atau sama dengan cbString, string output dalam *lpszString dipotong menjadi cbString dikurangi karakter null-termination. Argumen pcbString dapat berupa pointer null.

Kembali

Fungsi mengembalikan TRUE jika berhasil, FALSE jika gagal.

Diagnostik

Ketika SQLReadFileDSN 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 lpszString adalah NULL.

Argumen cbString kurang dari atau sama dengan 0.
ODBC_ERROR_INVALID_PATH Jalur penginstalan tidak valid Jalur nama file yang ditentukan dalam argumen lpszFileName tidak valid.
ODBC_ERROR_INVALID_REQUEST_TYPE Jenis permintaan tidak valid Argumen lpszAppName adalah NULL, sementara argumen lpszKeyName valid.
ODBC_ERROR_OUT_OF_MEM Kehabisan memori Alat penginstal tidak dapat melakukan fungsi karena kurangnya memori.
ODBC_ERROR_OUTPUT_STRING_TRUNCATED String output terpotong String yang dikembalikan dalam *lpszString dipotong karena nilai dalam cbString kurang dari atau sama dengan nilai dalam *pcbString.
ODBC_ERROR_REQUEST_FAILED Permintaan gagal Kata kunci tidak ada dalam file DSN.

Komentar

ODBC mencadangkan nama bagian [ODBC] untuk menyimpan informasi koneksi. Kata kunci yang dicadangkan untuk bagian ini sama dengan yang dicadangkan untuk string koneksi di SQLDriverConnect. (Untuk informasi selengkapnya, lihat Deskripsi fungsi SQLDriverConnect .)

Aplikasi dapat menggunakan kata kunci yang dipesan ini untuk membaca informasi dalam File DSN. Jika aplikasi ingin mengetahui string koneksi DSN-less yang terkait dengan File DSN, aplikasi dapat memanggil SQLReadFileDSN untuk salah satu kata kunci string koneksi yang dipesan di bagian [ODBC]. String koneksi lengkap yang diteruskan dalam koneksi tanpa DSN adalah kombinasi dari semua kata kunci (khusus cadangan dan driver) di bagian [ODBC].

Untuk informasi tentang Lihat
Menulis informasi ke File DSN SQLWriteFileDSN