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アクセス権で開かれている必要があります。 詳細については、「レジストリ キーのセキュリティとアクセス権のを
このハンドルは、
- 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 または空の文字列 ""
[in, optional] lpValue
レジストリ値の名前。
このパラメーターが NULL または空の文字列 ""
詳細については、「レジストリ要素のサイズ制限
[in, optional] dwFlags
クエリする値のデータ型を制限するフラグ。 値のデータ型がこの条件を満たしていない場合、関数は失敗します。 このパラメーターには、次の値のうち 1 つ以上を指定できます。
このパラメーターには、次の値の 1 つ以上を含めることもできます。
[out, optional] pdwType
指定した値に格納されているデータの型を示すコードを受け取る変数へのポインター。 使用可能な型コードの一覧については、「レジストリ値の型
[out, optional] pvData
値のデータを受け取るバッファーへのポインター。 データが不要な場合、このパラメーターは NULL
データが文字列の場合、関数は終端 null 文字をチェックします。 見つからない場合、バッファーが余分な文字を格納するのに十分な大きさの場合、文字列は null ターミネータと共に格納されます。 それ以外の場合、関数は失敗し、ERROR_MORE_DATAを返します。
[in, out, optional] pcbData
pvData パラメーターが指すバッファーのサイズをバイト単位で指定する変数へのポインター。 関数から制御が戻ると、この変数には、pvDataにコピー
データにREG_SZ、REG_MULTI_SZ、またはREG_EXPAND_SZの型がある場合、このサイズには、null 文字または文字
pvData パラメーター
pvData が NULL
hKey が HKEY_PERFORMANCE_DATA を指定し、pvData バッファーが返されるすべてのデータを格納するのに十分な大きさでない場合、関数はERROR_MORE_DATAを返し、pcbData パラメーターを介して返される値は未定義です。 これは、パフォーマンス データのサイズが 1 つの呼び出しから次の呼び出しに変わる可能性があるためです。 この場合は、バッファー サイズを大きくし、
戻り値
関数が成功した場合、戻り値はERROR_SUCCESS。
関数が失敗した場合、戻り値は
pvData バッファーが小さすぎて値を受け取れなければ、関数はERROR_MORE_DATAを返します。
lpValue レジストリ値が存在しない場合、関数はERROR_FILE_NOT_FOUNDを返します。
dwFlags
備考
アプリケーションは通常、
データにREG_SZ、REG_MULTI_SZ、またはREG_EXPAND_SZ型があり、この関数の ANSI バージョンが使用されている場合 (
hkeyHKEY_PERFORMANCE_DATA ハンドルと指定したオブジェクトの値文字列に設定してこの関数を呼び出すと、返されるデータ構造に要求されないオブジェクトが含まれる場合があります。 驚かないでください。これは通常の動作です。 要求されたオブジェクトを検索するには、返されるデータ構造を常に確認する必要があります。
特定のレジストリ キーにアクセスする操作はリダイレクトされることに注意してください。 詳細については、「レジストリ仮想化
この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNTを 0x0600 以降として定義します。 詳細については、「Windows ヘッダーの使用」を参照してください。
手記
winreg.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして RegGetValue を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。
必要条件
要件 | 価値 |
---|---|
サポートされる最小クライアント | Windows Vista、Windows XP Professional x64 Edition |
サポートされる最小サーバー | Windows Server 2008、Windows Server 2003 SP1 |
ターゲット プラットフォーム の |
ウィンドウズ |
ヘッダー | winreg.h (Windows.h を含む) |
ライブラリ | Advapi32.lib |
DLL | Advapi32.dll |
関連項目
RegCreateKeyEx の
RegEnumKeyEx を
RegEnumValue を
RegOpenKeyEx を
RegQueryInfoKey の
レジストリ関数 を