ORGetValue 関数
オフライン レジストリ ハイブ内の指定されたレジストリ値の型とデータを取得します。
構文
DWORD ORGetValue(
_In_ ORHKEY Handle,
_In_opt_ PCWSTR lpSubKey,
_In_opt_ PCWSTR lpValue,
_Out_opt_ PDWORD pdwType,
_Out_opt_ PVOID pvData,
_Inout_opt_ PDWORD pcbData
);
パラメーター
-
ハンドル [入力]
-
オフライン レジストリ ハイブで開いているレジストリ キーへのハンドル。
-
lpSubKey [in, optional]
-
レジストリ キーの名前。 このキーは、 Handle パラメーターで指定されたキーのサブキーである必要があります。 このパラメーターは、NULL でもかまいません。
キー名では大文字と小文字は区別されません。
-
lpValue [in, optional]
-
レジストリ値の名前。 このパラメーターが NULL または空の文字列 "" の場合、関数はキーの名前なしまたは既定値 (存在する場合) の型とデータを取得します。 詳細については、「 レジストリ要素のサイズ制限」を参照してください。
キーには、名前のない値や既定値が自動的に設定されません。 名前のない値には、任意の型を指定できます。
値名では大文字と小文字は区別されません。
-
pdwType [out, optional]
-
指定した値に格納されているデータの型を示すコードを受け取る変数へのポインター。 使用できる型コードの一覧については、「 レジストリ値の型」を参照してください。 型が不要な場合、このパラメーターは NULL にすることができます 。
-
pvData [out, optional]
-
値のデータを受け取るバッファーへのポインター。 データが必要ない場合、このパラメーターは NULL にすることができます 。
データが文字列の場合、関数は終端の null 文字をチェックします。 1 つが見つからない場合、バッファーが余分な文字に対応するのに十分な大きさである場合、文字列は null 終端記号で格納されます。 それ以外の場合、関数は失敗し、ERROR_MORE_DATAを返します。
-
pcbData [in, out, optional]
-
pvData パラメーターによって指されるバッファーのサイズをバイト単位で指定する変数へのポインター。 関数が戻るときに、この変数には pvData にコピーされたデータのサイズが含まれます。
pcbData パラメーターは、pvData が NULL の場合にのみ NULL にすることができます。
データにREG_SZ、REG_MULTI_SZ、またはREG_EXPAND_SZ型がある場合、このサイズには終端の null 文字または文字が含まれます。 詳細については、「解説」を参照してください。
pvData パラメーターで指定されたバッファーがデータを保持するのに十分な大きさでない場合、関数は ERROR_MORE_DATAを返し、必要なバッファー サイズを pcbData が指す変数に格納します。 この場合、 pvData バッファーの内容は未定義です。
pvData が NULL で、pcbData が NULL 以外の場合、関数は ERROR_SUCCESSを返し、データのサイズをバイト単位で pcbData が指す変数に格納します。 これにより、アプリケーションは値のデータにバッファーを割り当てる最適な方法を決定できます。
戻り値
関数が成功した場合、戻り値は ERROR_SUCCESS です。
関数が失敗した場合、戻り値は Winerror.h で定義されている 0 以外のエラー コードです。 FORMAT_MESSAGE_FROM_SYSTEM フラグを指定して FormatMessage 関数を使用すると、エラーの一般的な説明を取得できます。
解説
通常、アプリケーションは OREnumValue 関数を呼び出して値の名前を決定し、 ORGetValue 関数を呼び出して名前のデータを取得します。
要件
| 要件 | 値 |
|---|---|
| 再頒布可能パッケージ |
Windows オフライン レジストリ ライブラリ バージョン 1.0 以降 |
| ヘッダー |
|
| [DLL] |
|
関連項目