Fungsi SQLWriteFileDSN

Kesesuaian
Versi diperkenalkan: ODBC 3.0

Ringkasan
SQLWriteFileDSN menulis informasi ke File DSN.

Sintaks

  
BOOL SQLWriteFileDSN(  
     LPCSTR     lpszFileName,  
     LPCSTR     lpszAppName,  
     LPCSTR     lpszKeyName,  
     LPCSTR     lpszString);  

Argumen

lpszFileName
[Input] Penunjuk ke nama File DSN. Ekstensi DSN ditambahkan ke semua nama file yang belum memiliki ekstensi DSN.

lpszAppName
[Input] Penunjuk ke nama aplikasi. Ini adalah "ODBC" untuk bagian ODBC.

lpszKeyName
[Input] Arahkan ke nama kunci yang akan dibaca. Lihat "Komentar" untuk kata kunci yang dipesan.

lpszString
[Output] Menunjuk ke string yang terkait dengan kunci yang akan ditulis. Panjang maksimum string yang ditujukkan oleh argumen ini adalah 32.767 byte.

Kembali

Fungsi mengembalikan TRUE jika berhasil, FALSE jika gagal.

Diagnostik

Ketika SQLWriteFileDSN 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_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, lpszKeyName, atau lpszString adalah NULL.

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 menulis informasi langsung ke File DSN. Jika aplikasi ingin membuat atau memodifikasi string koneksi DSN-less yang terkait dengan File DSN, aplikasi dapat memanggil SQLWriteFileDSN untuk salah satu kata kunci string koneksi yang dipesan di bagian [ODBC].

Jika argumen lpszString adalah penunjuk null, kata kunci yang ditujukkan oleh argumen lpszKeyName akan dihapus dari file .dsn. Jika argumen lpszString dan lpszKeyName adalah penunjuk null, bagian yang ditujukkan oleh argumen lpszAppName akan dihapus dari file .dsn.

Fungsi Terkait

Untuk informasi tentang	Lihat
Membaca informasi dari DSN File	SQLReadFileDSN