SQLWritePrivateProfileString 関数

  • [アーティクル]

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

まとめ
SQLWritePrivateProfileString は、システム情報のOdbc.iniサブキーに値の名前とデータを書き込みます。

構文

  
BOOL SQLWritePrivateProfileString(  
     LPCSTR     lpszSection,  
     LPCSTR     lpszEntry,  
     LPCSTR     lpszString,  
     LPCSTR     lpszFilename);

引数

lpszSection
[入力]文字列のコピー先となるセクションの名前を含む null で終わる文字列を指します。 セクションが存在しない場合は作成されます。 セクションの名前は大文字と小文字が区別されません。文字列は、大文字と小文字の任意の組み合わせにすることができます。

lpszEntry
[入力]文字列に関連付けるキーの名前を含む null で終わる文字列を指します。 指定したセクションにキーが存在しない場合は、キーが作成されます。 この引数が NULL の場合、セクション内のすべてのエントリを含むセクション全体が削除されます。

lpszString
[入力]ファイルに書き込まれる null で終わる文字列を指します。 この引数が NULL の場合、lpszEntry 引数が指すキーは削除されます。

lpszFilename
[出力]初期化ファイルに名前を付ける null で終わる文字列を指します。

返品

この関数は成功した場合は TRUE を返し、失敗した場合は FAL Standard Edition を返します。

診断

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

*pfErrorCode エラー 説明
ODBC_ERROR_GENERAL_ERR インストーラーの一般的なエラー 特定のインストーラー エラーがないエラーが発生しました。
ODBC_ERROR_REQUEST_FAILED 要求が失敗しました 要求されたシステム情報を書き込めませんでした。
ODBC_ERROR_OUT_OF_MEM メモリ不足 メモリ不足のため、インストーラーで関数を実行できませんでした。

説明

SQLWritePrivateProfileString は、ドライバーとドライバーセットアップ DLL を Microsoft Windows から Microsoft Windows NT/Windows 2000 に移植する簡単な方法として提供されます。 Odbc.ini ファイルにプロファイル文字列を書き込む WritePrivateProfileString の呼び出しは、SQLWritePrivateProfileString の呼び出しに置き換える必要があります。 SQLWritePrivateProfileString は Win32 API の関数を呼び出して、指定した値の名前とデータをシステム情報のOdbc.iniサブキーに追加します。

構成モードは、DSN 値をリストするOdbc.ini項目がシステム情報内のどこにあるかを示します。 DSN がユーザー DSN (状態変数が U Standard Edition RDSN_ONLY) の場合、関数は HKEY_CURRENT_U Standard Edition R のOdbc.ini エントリに書き込みます。 DSN がシステム DSN (SYSTEMDSN_ONLY) の場合、関数は HKEY_LOCAL_MACHINE の Odbc.ini エントリに書き込みます。 状態変数が BOTHDSN の場合、HKEY_CURRENT_U Standard Edition R が試行され、失敗した場合はHKEY_LOCAL_MACHINEが使用されます。

対象 参照トピック
システム情報から値を取得する SQLGetPrivateProfileString