PSGetPropertyKeyFromName 関数 (propsys.h)

正規のプロパティ名のプロパティキーを取得します。

構文

PSSTDAPI PSGetPropertyKeyFromName(
  [in]  PCWSTR      pszName,
  [out] PROPERTYKEY *ppropkey
);

[in] pszName

種類: PCWSTR

null で終わる Unicode 文字列としてのプロパティ名へのポインター。

[out] ppropkey

この関数から制御が戻るときに、要求されたプロパティキーが格納されます。

型: HRESULT

次のいずれかの値を返します。

リターンコード	説明
S_OK	プロパティキー構造が取得されました。
E_INVALIDARG	pszName パラメーターは NULL です。
TYPE_E_ELEMENTNOTFOUND	標準プロパティ名がスキーマサブシステムキャッシュに存在しません。

プロパティキーは、プロパティを一意に識別します。たとえば、PKEY_Keywords は System.Keywords に対応します。この関数は、プロパティスキーマの一部として登録されたプロパティに対してのみ成功します。

関数でサポートされているレガシプロパティ名の一覧については、「 PSGetPropertyDescriptionByName 」を参照してください。

大規模なプログラムの一部として含める次の例では、 PSGetPropertyKeyFromName を使用しての System.Keywordsプロパティキーを取得する方法を示します。

PROPERTYKEY key;

HRESULT hr = PSGetPropertyKeyFromName(L"System.Keywords", &key);

if (SUCCEEDED(hr))
{
    // The property key is now valid.
}

要件	値
サポートされている最小のクライアント	WINDOWS XP と SP2、Windows Vista [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows Server 2003 SP1 [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	propsys.h
Library	Propsys.lib
[DLL]	Propsys.dll (バージョン 6.0 以降)
再頒布可能パッケージ	Windows デスクトップ検索 (WDS) 3.0