SQLWriteFileDSN 関数

  • [アーティクル]

準拠
導入されたバージョン: ODBC 3.0

まとめ
SQLWriteFileDSN は 、ファイル DSN に情報を書き込みます。

構文

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

引数

lpszFileName
[入力]ファイル DSN の名前へのポインター。 DSN 拡張子がまだ含まれていないすべてのファイル名に DSN 拡張子が追加されます。

lpszAppName
[入力]アプリケーションの名前へのポインター。 これは ODBC セクションの "ODBC" です。

lpszKeyName
[入力]読み取るキーの名前へのポインター。 予約済みキーワードについては、「コメント」を参照してください。

lpszString
[出力]書き込まれるキーに関連付けられている文字列を指します。 この引数が指す文字列の最大長は 32,767 バイトです。

戻り値

関数は成功した場合は TRUE を返し、失敗した場合は FALSE を返します。

診断

SQLWriteFileDSN が FALSE を返すと、SQLInstallerError を呼び出すことによって、関連付けられた *pfErrorCode 値を取得できます。 次の表に、SQLInstallerError によって返される *pfErrorCode 値の一覧を示し、この関数のコンテキストでそれぞれについて説明します。

*pfErrorCode エラー 説明
ODBC_ERROR_GENERAL_ERR 一般的なインストーラー エラー 特定のインストーラー エラーがないエラーが発生しました。
ODBC_ERROR_INVALID_PATH インストール パスが無効です lpszFileName 引数で指定されたファイル名のパスが無効です。
ODBC_ERROR_INVALID_REQUEST_TYPE 要求の種類が無効です lpszAppName、lpszKeyName、または lpszString 引数が NULL です。

説明

ODBC は、接続情報を格納するセクション名 [ODBC] を予約します。 このセクションの予約済みキーワードは、 SQLDriverConnect の接続文字列用に予約されているキーワードと同じです。 (詳細については、 SQLDriverConnect 関数の説明を参照してください)。

アプリケーションでは、これらの予約済みキーワードを使用して、ファイル DSN に情報を直接書き込むことができます。 アプリケーションがファイル DSN に関連付けられている DSN レス接続文字列を作成または変更する場合は、[ODBC] セクションの予約済み接続文字列キーワードに対して SQLWriteFileDSN を呼び出すことができます。

lpszString 引数が null ポインターの場合、lpszKeyName 引数が指すキーワードは .dsn ファイルから削除されます。 lpszString 引数と lpszKeyName 引数の両方が null ポインターである場合、lpszAppName 引数が指すセクションは .dsn ファイルから削除されます。

対象 解決方法については、
ファイル DSN からの情報の読み取り SQLReadFileDSN