InitPropVariantFromInt32Vector function (propvarutil.h)

Article
02/22/2024

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

Syntax

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

Parameters

[in] prgn

Type: const LONG*

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

[in] cElems

Type: ULONG

The number of vector elements.

[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_I4 propvariant.

Examples

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

LONG rgLongs[] = {1, 2, 7};
PROPVARIANT propvar;

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

if (SUCCEEDED(hr))
{
    // propvar now is valid and has type VT_VECTOR | VT_I4.
 
    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