InitPropVariantFromInt16Vector function (propvarutil.h)

Article
02/22/2024

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

Syntax

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

Parameters

[in] prgn

Type: const SHORT*

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

[in] cElems

Type: ULONG

The number of elements in the vector.

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

Examples

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

SHORT rgShorts[] = {3, 1, 4};
PROPVARIANT propvar;

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

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