InitVariantFromInt16Array function

Initializes a VARIANT structure with an array of 16-bit integer values.

Syntax


HRESULT InitVariantFromInt16Array(
  _In_  const SHORT   *prgn,
  _In_        ULONG   cElems,
  _Out_       VARIANT *pvar
);

Parameters

prgn [in]

Type: const SHORT*

Pointer to the source array of SHORT values.

cElems [in]

Type: ULONG

The number of elements in the array pointed to by prgn.

pvar [out]

Type: VARIANT*

When this function returns, contains the initialized VARIANT structure.

Return value

Type: HRESULT

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

Remarks

Creates a VT_ARRAY | VT_I2 variant.

Examples

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


SHORT rgShorts[] = {3, 1};
VARIANT var;

HRESULT hr = InitVariantFromInt16Array(rgShorts, ARRAYSIZE(rgShorts), &var);

if (SUCCEEDED(hr))
{
    // var now is valid and has type VT_ARRAY | VT_I2.
    VariantClear(&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

VariantToInt16Array
InitVariantFromInt16
InitPropVariantFromInt16Vector

 

 

Show: