InitVariantFromStringArray function (propvarutil.h)

Initializes a VARIANT structure with an array of strings.

Syntax

PSSTDAPI InitVariantFromStringArray(
  [in]  PCWSTR  *prgsz,
  [in]  ULONG   cElems,
  [out] VARIANT *pvar
);

Parameters

[in] prgsz

Type: PCWSTR*

Pointer to an array of strings.

[in] cElems

Type: ULONG

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

[out] pvar

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

See also

InitPropVariantFromString

InitVariantFromString

VariantToStringArray