StgConvertVariantToProperty

StgConvertVariantToProperty function

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

Syntax


SERIALIZEDPROPERTYVALUE* StgConvertPropertyToVariant(
  _In_        const PROPVARIANT             *pvar,
  _In_              USHORT                  CodePage,
  _Out_opt_         SERIALIZEDPROPERTYVALUE *pprop,
  _Inout_           ULONG                   *pcb,
  _In_              PROPID                  pid,
  _Reserved_        BOOLEAN                 fReserved,
  _Inout_opt_       ULONG                   *pcIndirect
);

Parameters

pvar [in]

A pointer to PROPVARIANT.

CodePage [in]

A property set codepage.

pprop [out, optional]

Optional. A pointer to SERIALIZEDPROPERTYVALUE.

pcb [in, out]

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

pid [in]

The propid (used if indirect).

fReserved [in]

Reserver. The value must be FALSE.

pcIndirect [in, out, optional]

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

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Propidl.h

Library

Ole32.lib

DLL

Ole32.dll

See also

StgConvertPropertyToVariant
StgSerializePropVariant

 

 

Community Additions

ADD
Show:
© 2016 Microsoft