Expand Minimize

PropVariantToUInt16VectorAlloc function

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

Syntax


HRESULT PropVariantToUInt16VectorAlloc(
  _In_   REFPROPVARIANT propvar,
  _Out_  USHORT **pprgn,
  _Out_  ULONG *pcElem
);

Parameters

propvar [in]

Type: REFPROPVARIANT

Reference to a source PROPVARIANT structure.

pprgn [out]

Type: USHORT**

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

pcElem [out]

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.

Return codeDescription
S_OK

Returns S_OK if successful, or an error value otherwise

E_INVALIDARG

The PROPVARIANT was not of the appropriate type.

 

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

Minimum supported client

Windows XP with SP2, Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 with SP1 [desktop apps only]

Redistributable

Windows Desktop Search (WDS) 3.0

Header

Propvarutil.h

Library

Propsys.lib

DLL

Propsys.dll (version 6.0 or later)

See also

InitPropVariantFromUInt16Vector
PropVariantToUInt16
PropVariantGetUInt16Elem
PropVariantToUInt16Vector
VariantToUInt16Array

 

 

Community Additions

ADD
Show:
© 2014 Microsoft