InitPropVariantFromUInt32Vector function (propvarutil.h)

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

Syntax

PSSTDAPI InitPropVariantFromUInt32Vector(
  [in]  const ULONG *prgn,
  [in]  ULONG       cElems,
  [out] PROPVARIANT *ppropvar
);

Parameters

[in] prgn

Type: const ULONG*

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

[in] cElems

Type: ULONG

Number of elements in the vector pointed to by prgn.

[out] ppropvar

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_UI4 propvariant.

Examples

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

ULONG rgLongs[] = {4, 7};
PROPVARIANT propvar;

HRESULT hr = InitPropVariantFromUInt32Vector(rgLongs, ARRAYSIZE(rgLongs), &propvar);

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

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

See also

InitPropVariantFromUInt32

InitVariantFromUInt32Array

PropVariantToUInt32Vector