PropVariantToGUID 関数 (propvarutil.h)
PROPVARIANT 構造体から GUID 値を抽出します。
構文
PSSTDAPI PropVariantToGUID(
[in] REFPROPVARIANT propvar,
[out] GUID *pguid
);
パラメーター
[in] propvar
型: REFPROPVARIANT
ソース PROPVARIANT 構造体への参照。
[out] pguid
型: GUID*
この関数が返されるときに、抽出されたプロパティ値が存在する場合は を格納します。
戻り値
種類: HRESULT
この関数が成功すると、 S_OKが返されます。 そうでない場合は、HRESULT エラー コードを返します。
注釈
このヘルパー関数は、次の型のPROPVARIANT 構造体に対して機能します。
- VT_GUID
- VT_BSTR
- VT_LPWSTR
- VT_ARRAY |VT_UI1
PropVariantToGUID は、呼び出し元のアプリケーションが PROPVARIANT が 1 つの GUID または GUID 値を保持することを想定している場所で使用されます。 たとえば、プロパティ ストアから値を取得するアプリケーションでは、これを使用して GUID プロパティの GUID 値を安全に抽出できます。
例
// IPropertyStore *ppropstore;
// Assume variable ppropstore is initialized and valid
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_Sync_HandlerCollectionID, &propvar);
if (SUCCEEDED(hr))
{
// PKEY_Sync_HandlerCollectionID is expected to produce a VT_CLSID or VT_EMPTY value.
// PropVariantToGUID will convert VT_EMPTY to a failure code.
GUID guidCollectionID;
hr = PropVariantToGUID(propvar, &guidCollectionID);
if (SUCCEEDED(hr))
{
// guidCollectionID is now valid
}
else
{
// the extraction failed
}
PropVariantClear(&propvar);
}
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | WINDOWS XP と SP2、Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2003 SP1 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | propvarutil.h |
| Library | Propsys.lib |
| [DLL] | Propsys.dll (バージョン 6.0 以降) |
| 再頒布可能パッケージ | Windows デスクトップ検索 (WDS) 3.0 |