Export (0) Print
Expand All
Expand Minimize

InitVariantFromStringArray function

Initializes a VARIANT structure with an array of strings.

Syntax


HRESULT InitVariantFromStringArray(
  _In_   PCWSTR *prgsz,
  _In_   ULONG cElems,
  _Out_  VARIANT *pvar
);

Parameters

prgsz [in]

Type: PCWSTR*

Pointer to an array of strings.

cElems [in]

Type: ULONG

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

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_BSTR variant.

Examples

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


PCWSTR rgStrings[] = {"dog", "cat"};
VARIANT var;

HRESULT hr = InitVariantFromStringArray(rgStrings, ARRAYSIZE(rgStrings), &var);

if (SUCCEEDED(hr))
{
    // var now is valid and has type VT_ARRAY | VT_BSTR.
    VariantClear(&var);
}

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

VariantToStringArray
InitVariantFromString
InitPropVariantFromString

 

 

Community Additions

ADD
Show:
© 2014 Microsoft