PropVariantToWinRTPropertyValue function (propsys.h)

Article
02/22/2024

Extracts data from a PROPVARIANT structure into a Windows Runtime property value. Note that in some cases more than one PROPVARIANT type maps to a single Windows Runtime property type.

Syntax

PSSTDAPI PropVariantToWinRTPropertyValue(
  [in]  REFPROPVARIANT propvar,
  [in]  REFIID         riid,
  [out] void           **ppv
);

Parameters

[in] propvar

Reference to a source PROPVARIANT structure.

[in] riid

A reference to the IID of the interface to retrieve through ppv, typically IID_IPropertyValue (defined in Windows.Foundation.h).

[out] ppv

When this method returns successfully, contains the interface pointer requested in riid. This is typically an IPropertyValue pointer. If the call fails, this value is NULL.

Return value

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

Remarks

We recommend that you use the IID_PPV_ARGS macro, defined in Objbase.h, to package the riid and ppv parameters. This macro provides the correct IID based on the interface pointed to by the value in ppv, which eliminates the possibility of a coding error in riid that could lead to unexpected results.

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2012 [desktop apps \| UWP apps]
Target Platform	Windows
Header	propsys.h (include Windows.Foundation.h)
Library	Propsys.lib
DLL	Propsys.dll