PropVariantGetBooleanElem, fonction (propvarutil.h)

Article
03/01/2024

Extrait un élément booléen unique d’une structure PROPVARIANT de type VT_BOOL, VT_VECTOR | VT_BOOLou VT_ARRAY | VT_BOOL.

Syntaxe

PSSTDAPI PropVariantGetBooleanElem(
  [in]  REFPROPVARIANT propvar,
  [in]  ULONG          iElem,
  [out] BOOL           *pfVal
);

Paramètres

[in] propvar

Type : REFPROPVARIANT

Référence à la structure PROPVARIANT source.

[in] iElem

Type : ULONG

Spécifie l’index du vecteur ou du tableau ; sinon, iElem doit être 0.

[out] pfVal

Type : BOOL*

Lorsque cette fonction est retournée, contient la valeur booléenne extraite.

Valeur retournée

Type : HRESULT

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

Remarques

Si la structure PROPVARIANT source a le type VT_BOOL, iElem doit être 0. Sinon, iElem doit être inférieur au nombre d’éléments dans le vecteur ou le tableau. Vous pouvez utiliser PropVariantGetElementCount pour obtenir le nombre d’éléments dans le vecteur ou le tableau.

L’exemple suivant utilise cette fonction pour parcourir en boucle les valeurs d’une structure PROPVARIANT .

Exemples

// PROPVARIANT propvar;
// assume propvar is initialized and valid

if ((propvar.vt & VT_TYPEMASK) == VT_BOOL)
{
    UINT cElem = PropVariantGetElementCount(propvar);
    HRESULT hr = <mark type="const">S_OK</mark>;
    
    for (UINT iElem = 0; SUCCEEDED(hr) && iElem < cElem; iElem ++)
    {
        BOOL fValue;
        hr = PropVariantGetBooleanElem(propvar, iElem, &fValue);
    
        if (SUCCEEDED(hr))
        {
            // fValue is valid now
        }
    }
}

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

PropVariantGetElem

Partager via