Expand Minimize

VariantToString function

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

Syntax


HRESULT VariantToString(
  _In_   REFVARIANT varIn,
  _Out_  PWSTR pszBuf,
  _In_   UINT cchBuf
);

Parameters

varIn [in]

Type: REFVARIANT

Reference to a source variant structure.

pszBuf [out]

Type: PWSTR

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

cchBuf [in]

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

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)

 

 

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.