Export (0) Print
Expand All
Expand Minimize

InitPropVariantFromStrRet function

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

Syntax


HRESULT InitPropVariantFromStrRet(
  _Inout_  STRRET *pstrret,
  _In_     PCUITEMID_CHILD pidl,
  _Out_    PROPVARIANT *ppropvar
);

Parameters

pstrret [in, out]

Type: STRRET*

Pointer to a STRRET structure that contains the string.

pidl [in]

Type: PCUITEMID_CHILD

PIDL of the item whose details are being retrieved.

ppropvar [out]

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

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)

See also

PropVariantToString
PropVariantToStringWithDefault
InitPropVariantFromString
InitVariantFromStrRet

 

 

Community Additions

ADD
Show:
© 2014 Microsoft