RegGetValueA 関数 (winreg.h)
指定したレジストリ値の型とデータを取得します。
構文
LSTATUS RegGetValueA(
[in] HKEY hkey,
[in, optional] LPCSTR lpSubKey,
[in, optional] LPCSTR lpValue,
[in, optional] DWORD dwFlags,
[out, optional] LPDWORD pdwType,
[out, optional] PVOID pvData,
[in, out, optional] LPDWORD pcbData
);
パラメーター
[in] hkey
開いているレジストリ キーへのハンドル。 キーは、KEY_QUERY_VALUEアクセス権で開かれている必要があります。 詳細については、「 レジストリ キーのセキュリティとアクセス権」を参照してください。
このハンドルは、 RegCreateKeyEx、 RegCreateKeyTransacted、 RegOpenKeyEx、または RegOpenKeyTransacted 関数によって返されます。 また、次の 定義済みキーのいずれかを指定することもできます。
- HKEY_CLASSES_ROOT
- HKEY_CURRENT_CONFIG
- HKEY_CURRENT_USER
- HKEY_LOCAL_MACHINE
- HKEY_PERFORMANCE_DATA
- HKEY_PERFORMANCE_NLSTEXT
- HKEY_PERFORMANCE_TEXT
- HKEY_USERS
[in, optional] lpSubKey
hkey パラメーターで指定されたキーを基準としたレジストリ キーのパス。 レジストリ値は、このサブキーから取得されます。
パスでは大文字と小文字は区別されません。
このパラメーターが NULL または空の文字列 "" の場合、 値は hkey 自体で指定されたキーから読み取られます。
[in, optional] lpValue
レジストリ値の名前。
このパラメーターが NULL または空の文字列 "" の場合、関数はキーの名前のない値または既定値 (存在する場合) の型とデータを取得します。 キーには名前のない値や既定値は自動的に設定されず、名前のない値は任意の型にすることができます。
詳細については、「 レジストリ要素のサイズ制限」を参照してください。
[in, optional] dwFlags
クエリを実行する値のデータ型を制限するフラグ。 値のデータ型がこの条件を満たしていない場合、関数は失敗します。 このパラメーターには、次の 1 つ以上の値を指定できます。
このパラメーターには、次の値の 1 つ以上を含めることもできます。
| 値 | 意味 |
|---|---|
|
値が REG_EXPAND_SZ 型の場合は、環境文字列を自動的に展開しないでください。 |
|
pvData が NULL でない場合は、障害発生時にバッファーの内容をゼロに設定します。 |
|
lpSubKey が NULL でない場合は、lpSubKey が指定するサブキーをKEY_WOW64_64KEYアクセス権で開きます。
これらのアクセス権の詳細については、「 レジストリ キーのセキュリティとアクセス権」を参照してください。
RRF_SUBKEY_WOW6432KEYと組み合わせてRRF_SUBKEY_WOW6464KEYを指定することはできません。 |
|
lpSubKey が NULL でない場合は、lpSubKey が指定するサブキーをKEY_WOW64_32KEYアクセス権で開きます。
これらのアクセス権の詳細については、「 レジストリ キーのセキュリティとアクセス権」を参照してください。
RRF_SUBKEY_WOW6464KEYと組み合わせてRRF_SUBKEY_WOW6432KEYを指定することはできません。 |
[out, optional] pdwType
指定した値に格納されているデータの種類を示すコードを受け取る変数へのポインター。 使用可能な型コードの一覧については、「 レジストリ値の型」を参照してください。 型が不要な場合、このパラメーターは NULL にすることができます。
[out, optional] pvData
値のデータを受け取るバッファーへのポインター。 データが不要な場合、このパラメーターは NULL にすることができます。
データが文字列の場合、関数は終端の null 文字をチェックします。 見つからない場合、バッファーが余分な文字に対応するのに十分な大きさの場合、文字列は null ターミネータで格納されます。 それ以外の場合、関数は失敗し、ERROR_MORE_DATAを返します。
[in, out, optional] pcbData
pvData パラメーターによって指されるバッファーのサイズをバイト単位で指定する変数へのポインター。 関数が戻るとき、この変数には pvData にコピーされたデータのサイズが含まれます。
pcbData パラメーターは、pvData が NULL の場合にのみ NULL にすることができます。
データにREG_SZ、REG_MULTI_SZ、またはREG_EXPAND_SZの型がある場合、このサイズには終端 の null 文字または文字が含まれます。 詳細については、「解説」を参照してください。
pvData パラメーターで指定されたバッファーがデータを保持するのに十分な大きさでない場合、この関数は ERROR_MORE_DATAを返し、必要なバッファー サイズを pcbData が指す変数に格納します。 この場合、dwFlags が RRF_ZEROONFAILUREを指定し、それ以外の場合は未定義の場合、 pvData バッファーの内容はゼロになります。
pvData が NULL で、pcbData が NULL 以外の場合、この関数は ERROR_SUCCESSを返し、データのサイズをバイト単位で pcbData が指す変数に格納します。 これにより、アプリケーションは値のデータにバッファーを割り当てる最適な方法を決定できます。
hKey がHKEY_PERFORMANCE_DATAを指定し、pvData バッファーが返されるすべてのデータを格納するのに十分な大きさでない場合、関数はERROR_MORE_DATAを返し、pcbData パラメーターを介して返される値は未定義です。 これは、パフォーマンス データのサイズが 1 回の呼び出しから次の呼び出しに変わる可能性があるためです。 この場合は、バッファー サイズを大きくし、更新されたバッファー サイズを pcbData パラメーターに渡して RegGetValue を再度呼び出す必要があります。 関数が成功するまで、これを繰り返します。 pcbData によって返される値は予測できないため、バッファー サイズを追跡するには、別の変数を維持する必要があります。
戻り値
関数が成功した場合、戻り値は ERROR_SUCCESS です。
関数が失敗した場合、戻り値は システム エラー コードです。
pvData バッファーが小さすぎて値を受け取れない場合、関数は ERROR_MORE_DATAを返します。
lpValue レジストリ値が存在しない場合、関数は ERROR_FILE_NOT_FOUNDを返します。
dwFlags でRRF_SUBKEY_WOW6464KEYとRRF_SUBKEY_WOW6432KEYの両方の組み合わせを指定した場合、関数はERROR_INVALID_PARAMETERを返します。
解説
通常、アプリケーションは RegEnumValue を呼び出して値の名前を決定し、 RegGetValue を呼び出して名前のデータを取得します。
データにREG_SZ、REG_MULTI_SZ、またはREG_EXPAND_SZ型があり、この関数の ANSI バージョンが使用されている場合 ( RegGetValueA を明示的に呼び出すか、Windows.h ファイルを含める前に UNICODE を定義しない場合)、この関数は格納されている Unicode 文字列を ANSI 文字列に変換してから 、pvData が指すバッファーにコピーします。
hkey をHKEY_PERFORMANCE_DATA ハンドルに設定し、指定したオブジェクトの値文字列を指定してこの関数を呼び出すと、返されるデータ構造に要求されていないオブジェクトが含まれる場合があります。 驚かないでください。これは通常の動作です。 返されたデータ構造を常にウォークして、要求されたオブジェクトを探す必要があります。
特定のレジストリ キーにアクセスする操作はリダイレクトされることに注意してください。 詳細については、「 レジストリの仮想化 」および「レジストリ内 の 32 ビットおよび 64 ビットアプリケーション データ」を参照してください。
この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNTを 0x0600 以降として定義します。 詳細については、「 Windows ヘッダーの使用」を参照してください。
Note
winreg.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして RegGetValue を定義します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| サポートされている最小のクライアント | Windows Vista、Windows XP Professional x64 Edition |
| サポートされている最小のサーバー | Windows Server 2008、Windows Server 2003 SP1 |
| 対象プラットフォーム | Windows |
| ヘッダー | winreg.h (Windows.h を含む) |
| Library | Advapi32.lib |
| [DLL] | Advapi32.dll |