PropVariantToUInt32Vector, fonction (propvarutil.h)

Article
03/04/2024

Extrait des données d’une structure PROPVARIANT dans un vecteur ULONG .

Syntaxe

PSSTDAPI PropVariantToUInt32Vector(
  [in]  REFPROPVARIANT propvar,
  [out] ULONG          *prgn,
  [in]  ULONG          crgn,
  [out] ULONG          *pcElem
);

Paramètres

[in] propvar

Type : REFPROPVARIANT

Référence à une structure PROPVARIANT source.

[out] prgn

Type : ULONG*

Pointe vers une mémoire tampon contenant des valeurs ULONGcrgn. Lorsque cette fonction est retournée, la mémoire tampon a été initialisée avec des éléments ULONGpcElem extraits de la source PROPVARIANT.

[in] crgn

Type : ULONG

Taille de la mémoire tampon pointée par prgn, dans les éléments.

[out] pcElem

Type : ULONG*

Lorsque cette fonction est retournée, contient le nombre de valeurs ULONG extraites 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.
TYPE_E_BUFFERTOOSMALL	La source PROPVARIANT contenait plus de valeurs crgn . La mémoire tampon pointée par prgn est trop petite.
E_INVALIDARG	Le PROPVARIANT n’était pas du type approprié.

Remarques

Cette fonction d’assistance est utilisée dans les endroits où l’application appelante s’attend à ce qu’un PROPVARIANT contienne un vecteur de valeurs ULONG avec un nombre fixe d’éléments.

Si la source PROPVARIANT a un type VT_VECTOR | VT_UI4 ou VT_ARRAY | VT_UI4, cette fonction d’assistance extrait jusqu’à crgnles valeurs ULONG et les place dans la mémoire tampon vers laquelle pointe prgn. Si PROPVARIANT contient plus d’éléments que ne le fera dans la mémoire tampon prgn , cette fonction retourne une erreur et définit pcElem sur 0.

Exemples

L’exemple suivant, à inclure dans le cadre d’un programme plus large, montre comment utiliser PropVariantToUInt32Vector pour accéder à une valeur vectorielle ULONG dans un PROPVARIANT.

// PROPVARIANT propvar;
// Assume the variable propvar is initialized and valid
ULONG rgLongs[4]; // The application is expecting propvar to hold 4 ULONGs in a vector
ULONG cElems;
HRESULT hr = PropVariantToUInt32Vector(propvar, rgLongs, ARRAYSIZE(rgLongs), &cElems);
if (SUCCEEDED(hr))
{
     if (cElems == ARRAYSIZE(rgLongs))
     {
         // The application got 4 ULONGs which are now stored in rgLongs
     }
     else
     {
         // The application got cElems which are stored in the first cElems elements of rgLongs
     }
}

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