nf-propvarutil-propvarianttouint16vector.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:propvarutil.PropVariantToUInt16Vector	PropVariantToUInt16Vector function (propvarutil.h)	Extracts data from a PROPVARIANT structure into an unsigned short vector.	PropVariantToUInt16Vector PropVariantToUInt16Vector function [Windows Properties] _shell_PropVariantToUInt16Vector properties.PropVariantToUInt16Vector propvarutil/PropVariantToUInt16Vector shell.PropVariantToUInt16Vector	properties\PropVariantToUInt16Vector.htm	properties	34fe404c-cef6-47d9-9eaf-8ab151bd4726	12/05/2018	PropVariantToUInt16Vector, PropVariantToUInt16Vector function [Windows Properties], _shell_PropVariantToUInt16Vector, properties.PropVariantToUInt16Vector, propvarutil/PropVariantToUInt16Vector, shell.PropVariantToUInt16Vector	propvarutil.h		Windows	Windows XP with SP2, Windows Vista [desktop apps only]	Windows Server 2003 with SP1 [desktop apps only]										Propsys.lib	Propsys.dll (version 6.0 or later)		Windows		Windows Desktop Search (WDS) 3.0	19H1	PropVariantToUInt16Vector propvarutil/PropVariantToUInt16Vector	c++	APIRef kbSyntax	DllExport	Propsys.dll	PropVariantToUInt16Vector

PropVariantToUInt16Vector function

-description

Extracts data from a PROPVARIANT structure into an unsigned short vector.

-parameters

-param propvar [in]

Type: REFPROPVARIANT

Reference to a source PROPVARIANT structure.

-param prgn [out]

Type: USHORT*

Points to a buffer containing crgn unsigned short values. When this function returns, the buffer has been initialized with pcElem unsigned short elements extracted from the source PROPVARIANT.

-param crgn [in]

Type: ULONG

Size of the buffer pointed to by prgn in elements.

-param pcElem [out]

Type: ULONG*

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

-returns

Type: HRESULT

This function can return one of these values.

Return code	Description
S_OK	Returns S_OK if successful, or an error value otherwise.
TYPE_E_BUFFERTOOSMALL	The source PROPVARIANT contained more than crgn values. The buffer pointed to by prgn.
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 with a fixed number of elements.

If the source PROPVARIANT has type VT_VECTOR | VT_UI2 or VT_ARRAY | VT_UI2, this helper function extracts up to crgn   unsigned short values and places them into the buffer pointed to by prgn. If the PROPVARIANT contains more elements than will fit into the prgn buffer, this function returns an error and sets pcElem to 0.

Examples

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

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

-see-also

InitPropVariantFromUInt16Vector

PropVariantGetUInt16Elem

PropVariantToUInt16

PropVariantToUInt16VectorAlloc

VariantToUInt16Array