InitPropVariantFromStrRet function (propvarutil.h)

Article
02/22/2024

Initializes a PROPVARIANT structure based on a string stored in a STRRET structure.

Syntax

PSSTDAPI InitPropVariantFromStrRet(
  [in, out] STRRET          *pstrret,
  [in]      PCUITEMID_CHILD pidl,
  [out]     PROPVARIANT     *ppropvar
);

Parameters

[in, out] pstrret

Type: STRRET*

Pointer to a STRRET structure that contains the string.

[in] pidl

Type: PCUITEMID_CHILD

PIDL of the item whose details are being retrieved.

[out] ppropvar

Type: PROPVARIANT*

When this function returns, contains the initialized PROPVARIANT structure.

Return value

Type: HRESULT

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

Remarks

Creates a VT_LPWSTR propvariant.

Note This function frees the memory used for the STRRET contents.

Examples

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

// STRRET strret;
// PCUITEMID_CHILD pidl;
// Assume variables strret and pidl are initialized and valid.
PROPVARIANT propvar;

HRESULT hr = InitPropVariantFromStrRet(strret, pidl, &propvar);

if (SUCCEEDED(hr))
{
    // propvar now is valid and has type VT_LPWSTR.
    PropVariantClear(&propvar);
    
    // Any allocated memory associated with strret has been freed.
}

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