VariantToStrRet function (propvarutil.h)

If the source variant is a VT_BSTR, extracts string and places it into a STRRET structure.

Syntax

PSSTDAPI VariantToStrRet(
  [in]  REFVARIANT varIn,
  [out] STRRET     *pstrret
);

Parameters

[in] varIn

Type: REFVARIANT

Reference to a source variant structure.

[out] pstrret

Type: STRRET*

Pointer to the extracted string if one exists.

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