RegQueryValueA 関数 (winreg.h)
指定したレジストリ キーの既定値または名前のない値に関連付けられているデータを取得します。 データは null で終わる文字列である必要があります。
構文
LSTATUS RegQueryValueA(
[in] HKEY hKey,
[in, optional] LPCSTR lpSubKey,
[out, optional] LPSTR lpData,
[in, out, optional] PLONG lpcbData
);
パラメーター
[in] hKey
開いているレジストリ キーへのハンドル。 キーは、KEY_QUERY_VALUEアクセス権で開かれている必要があります。 詳細については、「 レジストリ キーのセキュリティとアクセス権」を参照してください。
このハンドルは、 RegCreateKeyEx、 RegCreateKeyTransacted、 RegOpenKeyEx、または RegOpenKeyTransacted 関数によって返されます。 また、次の 定義済みキーのいずれかを指定することもできます。
- HKEY_CLASSES_ROOT
- HKEY_CURRENT_CONFIG
- HKEY_CURRENT_USER
- HKEY_LOCAL_MACHINE
- HKEY_USERS
[in, optional] lpSubKey
既定値が取得される hKey パラメーターのサブキーの名前。
キー名では大文字と小文字は区別されません。
このパラメーターが NULL であるか、空の文字列を指している場合、 関数は hKey で識別されるキーの既定値を取得します。
詳細については、「 レジストリ要素のサイズ制限」を参照してください。
[out, optional] lpData
指定したキーの既定値を受け取るバッファーへのポインター。
lpValue が NULL で、lpcbValue が NULL 以外の場合、この関数は ERROR_SUCCESSを返し、データのサイズをバイト単位で lpcbValue が指す変数に格納します。 これにより、アプリケーションは値のデータにバッファーを割り当てる最適な方法を決定できます。
[in, out, optional] lpcbData
lpValue パラメーターによって指されるバッファーのサイズをバイト単位で指定する変数へのポインター。 関数が戻るとき、この変数には、 lpValue にコピーされたデータのサイズ (終端の null 文字を含む) が 含まれます。
データにREG_SZ、REG_MULTI_SZ、またはREG_EXPAND_SZの型がある場合、このサイズには終端 の null 文字または文字が含まれます。 詳細については、「解説」を参照してください。
指定された バッファー lpValue がデータを保持するのに十分な大きさでない場合、関数は ERROR_MORE_DATAを返し、 lpcbValue が指す変数に必要なバッファー サイズを格納します。 この場合、 lpValue バッファーの内容は未定義です。
戻り値
関数が成功した場合、戻り値は ERROR_SUCCESS です。
関数が失敗した場合、戻り値は システム エラー コードです。
lpValue バッファーが小さすぎて値を受け取れない場合、関数は ERROR_MORE_DATAを返します。
解説
この関数の ANSI バージョンを使用する場合 ( RegQueryValueA を明示的に呼び出すか、Windows.h ファイルを含める前に UNICODE を定義しない場合)、この関数は格納されている Unicode 文字列を ANSI 文字列に変換してから 、lpValue パラメーターで指定されたバッファーにコピーします。
データにREG_SZ、REG_MULTI_SZ、またはREG_EXPAND_SZの型がある場合、文字列が適切な null 終端文字で格納されていない可能性があります。 したがって、関数がERROR_SUCCESSを返した場合でも、アプリケーションは文字列を使用する前に適切に終了するようにする必要があります。それ以外の場合は、バッファーが上書きされる可能性があります。 (REG_MULTI_SZ文字列には 、null で終わる 2 つの文字を含める必要があることに注意してください)。
特定のレジストリ キーにアクセスする操作はリダイレクトされることに注意してください。 詳細については、「レジストリの仮想化」および「レジストリ内の 32 ビットおよび 64 ビット アプリケーション データ」を参照してください。
注意
winreg.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして RegQueryValue を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winreg.h (Windows.h を含む) |
| Library | Advapi32.lib |
| [DLL] | Advapi32.dll |