InitPropVariantFromDoubleVector function (propvarutil.h)

Article
02/22/2024

Initializes a PROPVARIANT structure based on a specified vector of double values.

Syntax

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

Parameters

[in, optional] prgn

Type: const DOUBLE*

Pointer to a double vector. If this value is NULL, the elements pointed to by the cadbl.pElems structure member are initialized with 0.0.

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

Examples

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

PROPVARIANT propvar;
DOUBLE rgDouble[] = {3.1415, 42.7};

HRESULT hr = InitPropVariantFromDoubleVector(rgDouble, ARRAYSIZE(rgDouble), &propvar);

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