PropVariantToUInt16VectorAlloc function (propvarutil.h)

Extracts data from a PROPVARIANT structure into a newly-allocated unsigned short vector.

Syntax

PSSTDAPI PropVariantToUInt16VectorAlloc(
  [in]  REFPROPVARIANT propvar,
  [out] USHORT         **pprgn,
  [out] ULONG          *pcElem
);

Parameters

[in] propvar

Type: REFPROPVARIANT

Reference to a source PROPVARIANT structure.

[out] pprgn

Type: USHORT**

When this function returns, contains a pointer to a vector of unsigned short values extracted from the source PROPVARIANT structure.

[out] pcElem

Type: ULONG*

When this function returns, contains the count of unsigned short values extracted from the source PROPVARIANT structure.

Return value

Type: HRESULT

This function can return one of these values.

Remarks

This helper function is used in places where the calling application expects a PROPVARIANT to hold a vector of unsigned short values.

If the source PROPVARIANT has type VT_VECTOR | VT_UI2 or VT_ARRAY | VT_UI2, this function extracts a vector of unsigned short values into a newly allocated vector. The calling application is responsible for using CoTaskMemFree to release the vector pointed to by pprgn when it is no longer needed.

Examples

The following example, to be included as part of a larger program, demonstrates how to use PropVariantToUInt16VectorAlloc to access a unsigned short vector value in a PROPVARIANT.

// PROPVARIANT propvar;
// Assume the variable propvar is initialized and valid. The application is expecting propvar to contain a vector of <dtype rid="ushort"/> values.
USHORT *prgShorts;
ULONG cElems;
HRESULT hr = PropVariantToUInt16VectorAlloc(propvar, & prgShorts, &cElems);
if (SUCCEEDED(hr))
{
     // prgShorts now points to a vector of cElems USHORTs.
     CoTaskMemFree(prgShorts);
}

Requirements

See also

InitPropVariantFromUInt16Vector

PropVariantGetUInt16Elem

PropVariantToUInt16

PropVariantToUInt16Vector

VariantToUInt16Array