SQLGetPrivateProfileString 関数

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

まとめ
SQLGetPrivateProfileString は、システム情報の値に対応する値またはデータの名前の一覧を取得します。

構文

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

引数

lpszSection
[入力]キー名を含むセクションを指定する null で終わる文字列を指します。 この引数が NULL の場合、関数はファイル内のすべてのセクション名を指定されたバッファーにコピーします。

lpszEntry
[入力]関連付けられた文字列を取得するキー名を含む null で終わる文字列を指します。 この引数が NULL の場合、lpszSection 引数で指定されたセクション内のすべてのキー名が、RetBuffer 引数で指定されたバッファーにコピーされます。

lpszDefault
[入力]初期化ファイルでキーが見つからない場合に、指定されたキーの既定値を指定する null で終わる文字列を指します。 この引数を NULL にすることはできません。

RetBuffer
[出力]取得した文字列を受け取るバッファーを指します。

cbRetBuffer
[入力]RetBuffer 引数が指すバッファーのサイズを文字数で指定します。

lpszFilename
[入力]初期化ファイルに名前を付ける null で終わる文字列を指します。 この引数にファイルへの完全なパスが含まれていない場合は、既定のディレクトリが検索されます。

返品

SQLGetPrivateProfileString は、読み取られた文字数を示す整数値を返します。

診断

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

*pfErrorCode	エラー	説明
ODBC_ERROR_GENERAL_ERR	インストーラーの一般的なエラー	特定のインストーラー エラーがないエラーが発生しました。
ODBC_ERROR_OUT_OF_MEM	メモリ不足	メモリ不足のため、インストーラーで関数を実行できませんでした。

説明

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

構成モード (SQLSetConfigMode によって設定) は、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が使用されます。

関連する関数

対象	参照トピック
システム情報への値の書き込み	SQLWritePrivateProfileString