Fonction PropVariantToBooleanVectorAlloc (propvarutil.h)

Article
08/25/2023

Extrait les données d’une structure PROPVARIANT dans un vecteur booléen nouvellement alloué.

Syntaxe

PSSTDAPI PropVariantToBooleanVectorAlloc(
  [in]  REFPROPVARIANT propvar,
  [out] BOOL           **pprgf,
  [out] ULONG          *pcElem
);

Paramètres

[in] propvar

Type : REFPROPVARIANT

Référence à une structure PROPVARIANT source.

[out] pprgf

Type : BOOL**

Lorsque cette fonction retourne, contient un pointeur vers un vecteur de valeurs booléennes extraites de la structure PROPVARIANT source.

[out] pcElem

Type : ULONG*

Lorsque cette fonction retourne, contient le nombre d’éléments booléens extraits de la structure PROPVARIANT source.

Valeur retournée

Type : HRESULT

Cette fonction peut retourner l’une de ces valeurs.

Code de retour	Description
S_OK	Retourne S_OK en cas de réussite, ou une valeur d’erreur dans le cas contraire.
E_INVALIDARG	LEPROPVARIANT n’était pas du type approprié.

Notes

Cette fonction d’assistance est utilisée dans les endroits où l’application appelante s’attend à ce qu’un PROPVARIANT contienne une valeur de vecteur booléen.

Si la source PROPVARIANT a le type VT_VECTOR | VT_BOOL ou VT_ARRAY | VT_BOOL, cette fonction extrait un vecteur de valeurs booléennes dans un vecteur nouvellement alloué de valeurs BOOL . L’application appelante est responsable de l’utilisation de CoTaskMemFree pour libérer le vecteur pointé par pprgf lorsqu’il n’est plus nécessaire.

Exemples

L’exemple suivant, à inclure dans le cadre d’un programme plus grand, montre comment utiliser PropVariantToBooleanVectorAlloc pour accéder à une valeur vectorielle booléenne dans un PROPVARIANT.

// PROPVARIANT propvar;
// Assume the variable propvar is initialized and valid. The application is 
// expecting propvar to contain a vector of Boolean values.
BOOL *prgFlags;
ULONG cFlags;
HRESULT hr = PropVariantToBooleanVectorAlloc(propvar, &prgFlags, &cFlags);

if (SUCCEEDED(hr))
{
     // The prgFlags variable now points to a vector that contains a count
     // of cFlags flags.
     CoTaskMemFree(prgFlags);
}

Spécifications


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