VariantToStringArray function (propvarutil.h)

Extracts data from a vector structure into a String array.

Syntax

PSSTDAPI VariantToStringArray(
  [in]  REFVARIANT var,
  [out] PWSTR      *prgsz,
  [in]  ULONG      crgsz,
  [out] ULONG      *pcElem
);

Parameters

[in] var

Type: REFVARIANT

Reference to a source variant structure.

[out] prgsz

Type: PWSTR*

Pointer to the string data extracted from source variant structure.

[in] crgsz

Type: ULONG

Specifies string array size.

[out] pcElem

Type: ULONG*

Pointer to the count of string elements extracted from source variant structure.

Return value

Type: HRESULT

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

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