VariantToUInt16Array function (propvarutil.h)

Extracts data from a vector structure into an unsigned Int16 array.

Syntax

PSSTDAPI VariantToUInt16Array(
  [in]  REFVARIANT var,
  [out] USHORT     *prgn,
  [in]  ULONG      crgn,
  [out] ULONG      *pcElem
);

Parameters

[in] var

Type: REFVARIANT

Reference to a source variant structure.

[out] prgn

Type: USHORT*

Pointer to the unsigned Int16 data extracted from source variant structure.

[in] crgn

Type: ULONG

Specifies unsigned Int16 array size.

[out] pcElem

Type: ULONG*

Pointer to the count of unsigned Int16 elements extracted from source variant structure.

Return value

Type: HRESULT

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Requirement Value
Minimum supported client Windows XP with SP2, Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 with SP1 [desktop apps only]
Target Platform Windows
Header propvarutil.h
Library Propsys.lib
DLL Propsys.dll (version 6.0 or later)
Redistributable Windows Desktop Search (WDS) 3.0