VariantToString function (propvarutil.h)

Extracts the variant value of a variant structure to a string. If no value can be extracted, then a default value is assigned.

Syntax

PSSTDAPI VariantToString(
  [in]  REFVARIANT varIn,
  [out] PWSTR      pszBuf,
  [in]  UINT       cchBuf
);

Parameters

[in] varIn

Type: REFVARIANT

Reference to a source variant structure.

[out] pszBuf

Type: PWSTR

Pointer to the extracted property value if one exists; otherwise, empty.

[in] cchBuf

Type: UINT

Specifies string length, in characters.

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