PSGetPropertyKeyFromName 関数 (propsys.h)
正規のプロパティ名のプロパティ キーを取得します。
構文
PSSTDAPI PSGetPropertyKeyFromName(
[in] PCWSTR pszName,
[out] PROPERTYKEY *ppropkey
);
パラメーター
[in] pszName
種類: PCWSTR
null で終わる Unicode 文字列としてのプロパティ名へのポインター。
[out] ppropkey
型: PROPERTYKEY*
この関数から制御が戻るときに、要求されたプロパティ キーが格納されます。
戻り値
型: HRESULT
次のいずれかの値を返します。
| リターン コード | 説明 |
|---|---|
|
プロパティ キー構造が取得されました。 |
|
pszName パラメーターは NULL です。 |
|
標準プロパティ名がスキーマ サブシステム キャッシュに存在しません。 |
注釈
プロパティ キーは、プロパティを一意に識別します。 たとえば、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 |