InitPropVariantFromUInt16Vector function

Initializes a PROPVARIANT structure based on a vector of 16-bit unsigned integer values.

Syntax


HRESULT InitPropVariantFromUInt16Vector(
  _In_  const USHORT      *prgn,
  _In_        ULONG       cElems,
  _Out_       PROPVARIANT *ppropvar
);

Parameters

prgn [in]

Type: const USHORT*

Pointer to a source vector of USHORT values. If this parameter is NULL, the PROPVARIANT is initialized with zeros.

cElems [in]

Type: ULONG

Number of elements in the vector pointed to by prgn.

ppropvar [out]

Type: PROPVARIANT*

When this function returns, contains the initialized PROPVARIANT structure.

Return value

Type: HRESULT

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

Remarks

Creates a VT_VECTOR | VT_UI2 propvariant.

Examples

The following example, to be included as part of a larger program, demonstrates how to use InitPropVariantFromUInt16Vector.


USHORT rgShorts[] = {4, 7};
PROPVARIANT propvar;

HRESULT hr = InitPropVariantFromUInt16Vector(rgShorts, ARRAYSIZE(rgShorts), &propvar);

if (SUCCEEDED(hr))
{
    // propvar now is valid and has type VT_VECTOR | VT_UI2.
     PropVariantClear(&propvar);
}

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

PropVariantToUInt16Vector
InitPropVariantFromUInt16
InitVariantFromUInt16

 

 

Show: