Función PropVariantToInt32VectorAlloc (propvarutil.h)

Artículo
03/05/2024

Extrae datos de una estructura PROPVARIANT en un vector Int32 recién asignado.

Sintaxis

PSSTDAPI PropVariantToInt32VectorAlloc(
  [in]  REFPROPVARIANT propvar,
  [out] LONG           **pprgn,
  [out] ULONG          *pcElem
);

Parámetros

[in] propvar

Tipo: REFPROPVARIANT

Referencia a una estructura PROPVARIANT de origen.

[out] pprgn

Tipo: LONG**

Cuando esta función devuelve , contiene un puntero a un vector de valores LONG extraídos de la estructura PROPVARIANT de origen.

[out] pcElem

Tipo: ULONG*

Cuando esta función devuelve, contiene el recuento de elementos LONG 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.
E_INVALIDARG	ElPROPVARIANT 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 valor de vector Int32.

Si el PROPVARIANT de origen tiene VT_VECTOR VT_I4 | oVT_ARRAY VT_I4 | , esta función extrae un vector de valores LONG en un vector recién asignado. La aplicación que realiza la llamada es responsable de usar CoTaskMemFree para liberar el vector al que apunta pprgn cuando ya no es necesario.

Ejemplos

En el ejemplo siguiente, para incluirse como parte de un programa mayor, se muestra cómo usar PropVariantToInt32VectorAlloc para tener acceso a un valor de vector LONG en un PROPVARIANT.

// PROPVARIANT propvar;
// Assume the variable propvar is initialized and valid. The application is expecting propvar to contain a vector of LONG values.
LONG *prgLongs;
ULONG cElems;
HRESULT hr = PropVariantToInt32VectorAlloc(propvar, &prgLongs, &cElems);
if (SUCCEEDED(hr))
{
     // prgLongs now points to a vector of cElems LONGs.
     CoTaskMemFree(prgLongs);
}

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