PropVariantToGUID, fonction (propvarutil.h)

Extrait une valeur GUID d’une structure PROPVARIANT .

Syntaxe

PSSTDAPI PropVariantToGUID(
  [in]  REFPROPVARIANT propvar,
  [out] GUID           *pguid
);

Paramètres

[in] propvar

Type : REFPROPVARIANT

Référence à une structure PROPVARIANT source.

[out] pguid

Type : GUID*

Lorsque cette fonction est retournée, contient la valeur de la propriété extraite, le cas échéant.

Valeur retournée

Type : HRESULT

Si cette fonction réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.

Remarques

Cette fonction d’assistance fonctionne pour les structuresPROPVARIANT des types suivants :

• VT_GUID
• VT_BSTR
• VT_LPWSTR
• VT_ARRAY | VT_UI1

PropVariantToGUID est utilisé dans les endroits où l’application appelante s’attend à ce qu’un PROPVARIANT contienne une seule valeur GUID ou GUID . Par instance, une application qui obtient des valeurs à partir d’un magasin de propriétés peut l’utiliser pour extraire en toute sécurité la valeur GUID des propriétés GUID.

Exemples

// 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);

}

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows XP avec SP2, Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 avec SP1 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	propvarutil.h
Bibliothèque	Propsys.lib
DLL	Propsys.dll (version 6.0 ou ultérieure)
Composant redistribuable	Windows Desktop Search (WDS) 3.0

Voir aussi

InitPropVariantFromCLSID

PropVariantToCLSID

VariantToGUID