StgConvertVariantToProperty function (propidl.h)

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

Syntax

SERIALIZEDPROPERTYVALUE * StgConvertVariantToProperty(
  [in]                const PROPVARIANT       *pvar,
  [in]                USHORT                  CodePage,
  [out, optional]     SERIALIZEDPROPERTYVALUE *pprop,
  [in, out]           ULONG                   *pcb,
  [in]                PROPID                  pid,
  [in]                BOOLEAN                 fReserved,
  [in, out, optional] ULONG                   *pcIndirect
);

Parameters

[in] pvar

A pointer to PROPVARIANT.

[in] CodePage

A property set codepage.

[out, optional] pprop

Optional. A pointer to SERIALIZEDPROPERTYVALUE.

[in, out] pcb

A pointer to the remaining stream length, updated to the actual property size on return.

[in] pid

The propid (used if indirect).

[in] fReserved

Reserver. The value must be FALSE.

[in, out, optional] pcIndirect

Optional. A pointer to the indirect property count.

Return value

Returns a pointer to SERIALIZEDPROPERTYVALUE.

Remarks

This function converts a PROPVARIANT to a property. If the function fails it throws an exception that represents STATUS_INVALID_PARAMETER NT_STATUS.

Requirements

See also

StgConvertPropertyToVariant

StgSerializePropVariant