SHRegGetValueFromHKCUHKLM 関数 (shlwapi.h)

[この関数はサポートされなくなりました。]

レジストリから指定された情報を取得します。 この関数は、指定したサブキーで要求された情報をチェック HKEY_CURRENT_USERします。 HKEY_CURRENT_USERサブツリーの下に情報が存在しない場合、関数はHKEY_LOCAL_MACHINEサブツリーで同じ情報をチェックします。

構文

LSTATUS SHRegGetValueFromHKCUHKLM(
  [in]      PCWSTR pwszKey,
  [in]      PCWSTR pwszValue,
  [in]      SRRF   srrfFlags,
  [out]     DWORD  *pdwType,
  [in]      void   *pvData,
  [in, out] DWORD  *pcbData
);

パラメーター

[in] pwszKey

種類: PCWSTR

レジストリ キーへのパスを指定する null で終わる Unicode 文字列へのポインター。

[in] pwszValue

種類: PCWSTR

キー値を指定する null で終わる Unicode 文字列へのポインター。 この値は NULL にすることができます。この場合、データは既定値から取得されます。

[in] srrfFlags

種類: SRRF

SRRF フラグ定数。 複数のフラグを使用する場合は、ビットごとの OR を使用して組み合わせることができます。 これらのフラグは、返されるデータの種類を制限するために使用されます。 この値を 0 にすることはできません。

[out] pdwType

種類: DWORD*

この関数が戻るとき、 には、指定した値に格納されているデータの型を示すコードを受け取る DWORD へのポインターが含まれます。 型情報が必要ない場合は 、NULL に設定できます。 この値が NULL ではなく、SRRF_NOEXPAND フラグが設定されていない場合、REG_EXPAND_SZのデータ型は、このメソッドで自動的に展開されるため、REG_SZとして返されます。

[in] pvData

種類: LPCVOID

値のデータを含むバッファーへのポインター。 データが必要ない場合、このパラメーターは NULL にすることができます。 この値には、エントリ時の pvData バッファーのサイズが含まれている必要があります。 pvData が NULL の場合 (または、pvData が NULL ではないが、レジストリ データを保持するにはバッファーが小さすぎる場合)、終了時にレジストリ データを保持するために必要なサイズが格納されます。

[in, out] pcbData

種類: DWORD*

この関数が戻るとき、 には、データのサイズへのポインターがバイト単位で格納されます。

戻り値

型: LONG

成功した場合、この関数はERROR_SUCCESSと要求されたすべての out パラメーターを返します。 指定された NULL 以外の pvData の領域が不足しているために関数が失敗した場合は、ERROR_MORE_DATAを返します。 この場合、 pdwType と pcbData のみが有効なデータを含む場合、 pvData は未定義になります。 それ以外の場合は、Winerror.h で定義されている 0 以外のエラー コードを返します。 FormatMessage 関数を FORMAT_MESSAGE_FROM_SYSTEM フラグと共に使用して、エラーの一般的な説明を取得できます。

要件