Función PropVariantToUInt32Vector (propvarutil.h)

Artículo
03/01/2024

Extrae datos de una estructura PROPVARIANT en un vector ULONG .

Sintaxis

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

Parámetros

[in] propvar

Tipo: REFPROPVARIANT

Referencia a una estructura PROPVARIANT de origen.

[out] prgn

Tipo: ULONG*

Apunta a un búfer que contiene valores de ULONG de crgn. Cuando esta función devuelve, el búfer se ha inicializado con elementos pcElemULONG extraídos del PROPVARIANT de origen.

[in] crgn

Tipo: ULONG

Tamaño del búfer al que apunta prgn, en elementos.

[out] pcElem

Tipo: ULONG*

Cuando se devuelve esta función, contiene el recuento de valores de ULONG extraídos de la estructura PROPVARIANT de origen.

Valor devuelto

Tipo: HRESULT

Esta función puede devolver uno de estos valores.

Código devuelto	Descripción
S_OK	Devuelve S_OK si se ejecuta correctamente o un valor de error de lo contrario.
TYPE_E_BUFFERTOOSMALL	El PROPVARIANT de origen contenía más de valores crgn . El búfer al que apunta prgn es demasiado pequeño.
E_INVALIDARG	El PROPVARIANT no era del tipo adecuado.

Comentarios

Esta función auxiliar se usa en lugares donde la aplicación que realiza la llamada espera que un PROPVARIANT contenga un vector de valores ULONG con un número fijo de elementos.

Si el PROPVARIANT de origen tiene el tipo VT_VECTOR VT_UI4 | o VT_ARRAY VT_UI4 | , esta función auxiliar extrae hasta valores ULONG de crgn y los coloca en el búfer al que apunta prgn. Si el PROPVARIANT contiene más elementos de los que caberán en el búfer de prgn , esta función devuelve un error y establece pcElem en 0.

Ejemplos

En el ejemplo siguiente, para incluirse como parte de un programa más grande, se muestra cómo usar PropVariantToUInt32Vector para tener acceso a un valor de vector ULONG en 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
     }
}

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows XP con SP2, Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 con SP1 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	propvarutil.h
Library	Propsys.lib
Archivo DLL	Propsys.dll (versión 6.0 o posterior)
Redistribuible	Búsqueda de escritorio de Windows (WDS) 3.0