StgConvertPropertyToVariant function (propidl.h)

Article
10/13/2021

The StgConvertPropertyToVariant function converts a SERIALIZEDPROPERTYVALUE data type to a PROPVARIANT data type.

Syntax

BOOLEAN StgConvertPropertyToVariant(
  [in]  const SERIALIZEDPROPERTYVALUE *pprop,
  [in]  USHORT                        CodePage,
  [out] PROPVARIANT                   *pvar,
  [in]  PMemoryAllocator              *pma
);

Parameters

[in] pprop

A pointer to SERIALIZEDPROPERTYVALUE.

[in] CodePage

A property set codepage.

[out] pvar

A pointer to PROPVARIANT.

[in] pma

A pointer to a class that implements the IMemoryAllocator abstract class.

Return value

Returns TRUE is the property converted was an indirect type (VT_STREAM or VT_STREAMED_OBJECT); otherwise FALSE.

Remarks

This function converts a property to a PROPVARIANT data type. If the function fails, it throws an exception that represents an NT_STATUS such as STATUS_INVALID_PARAMETER.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	propidl.h
Library	Ole32.lib
DLL	Ole32.dll