InitVariantFromStrRet function (propvarutil.h)

Initializes a VARIANT structure with a string stored in a STRRET structure.

Syntax

PSSTDAPI InitVariantFromStrRet(
  [in]  STRRET          *pstrret,
  [in]  PCUITEMID_CHILD pidl,
  [out] VARIANT         *pvar
);

Parameters

[in] pstrret

Type: STRRET*

Pointer to a STRRET structure.

[in] pidl

Type: PCUITEMID_CHILD

PIDL of the item whose details are being retrieved.

[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_BSTR variant.

Examples

The following example, to be included as part of a larger program, demonstrates how to use InitVariantFromStrRet.

// STRRET strret;
// PCUITEMID_CHILD pidl;
// Assume variables strret and pidl are initialized and valid.
VARIANT var;

HRESULT hr = InitVariantFromStrRet(strret, pidl, &var);

if (SUCCEEDED(hr))
{
    // var now is valid and has type VT_BSTR.
    VariantClear(&var);
}

Requirements

See also

InitVariantFromString

VariantToString

VariantToStringWithDefault