IWDFNamedPropertyStore::GetNamedValue メソッド (wudfddi.h)

  • [アーティクル]

[警告: UMDF 2 は UMDF の最新バージョンであり、UMDF 1 よりも優先されます。 すべての新しい UMDF ドライバーは、UMDF 2 を使用して記述する必要があります。 UMDF 1 には新機能が追加されておらず、新しいバージョンのWindows 10では UMDF 1 のサポートが制限されています。 ユニバーサル Windows ドライバーでは UMDF 2 を使用する必要があります。 詳細については、「UMDF を使用したはじめに」を参照してください。

GetNamedValue メソッドは、プロパティの値を取得します。

構文

HRESULT GetNamedValue(
  [in]  LPCWSTR     pszName,
  [out] PROPVARIANT *pv
);

パラメーター

[in] pszName

プロパティの名前を含む null で終わる文字列へのポインター。

[out] pv

プロパティの値を受け取る変数へのポインター。

戻り値

GetNamedValue は 、操作が成功した場合にS_OKを返します。 それ以外の場合、このメソッドは Winerror.h で定義されているエラー コードのいずれかを返します。

注釈

GetNamedValue メソッドは、pv パラメーターが指す PROPVARIANT 構造体の文字列にメモリを割り当てます。 次のスニペットに示すように、呼び出し元は PropVariantClear 関数を呼び出して、このメモリを解放する必要があります。

hr = pPropStore->GetNamedValue(L"Host", &val);
...
PropVariantClear(&val);

呼び出し元がメモリを解放しないと、メモリ リークが発生する可能性があります。

プロパティ値では、次のバリアント型がサポートされています。 次の表は、元のバリアント型に関係なく返されるバリアント型を示しています。

バリアント型 取得されたバリアント型
VT_BSTR クライアントが文字列値を読み取る間、値の書き込みに使用された元のバリアント型に関係なく、値はVT_LPWSTRとして返されます。
VT_LPWSTR
VT_LPSTR
VT_I1 クライアントは整数値を読み取りますが、値の書き込みに使用された元のバリアント型に関係なく、値はVT_UI4として返されます。
VT_UI1
VT_I2
VT_UI2
VT_I4
VT_UI4
VT_UINT
VT_BLOB バイナリ値は、VT_BLOBとして返されます。
VT_VECTOR |VT_LPWSTR 文字列配列は VT_VECTOR | として返されます。VT_LPWSTR
 

環境変数を含む文字列は、読み取り時に展開されます。

詳細については、「 UMDF ベースのドライバーでのレジストリの使用」を参照してください。

要件

要件 値
サポート終了 UMDF 2.0 以降では使用できません。
対象プラットフォーム デスクトップ
最小 UMDF バージョン 1.5
Header wudfddi.h (Wudfddi.h を含む)
[DLL] WUDFx.dll

こちらもご覧ください

IWDFNamedPropertyStore

PROPVARIANT

PropVariantClear