StgDeserializePropVariant function

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

Syntax


HRESULT StgDeserializePropVariant(
  _In_   const SERIALIZEDPROPERTYVALUE *pprop,
  _In_   ULONG *cbMax,
  _Out_  PROPVARIANT *pvar
);

Parameters

pprop [in]

A pointer to the SERIALIZEDPROPERTYVALUE buffer.

cbMax [in]

The size of the pprop buffer in bytes.

pvar [out]

A pointer to a PROPVARIANT.

Return value

This function can return one of these values.

S_OK

Indicates that the SERIALIZEDPROPERTYVALUE was properly deserialized.

STATUS_INVALID_PARAMETER

Indicates that the value of pVar or ppProp is NULL.

E_OUTOFMEMORY

Indicates that there was not enough memory to allocate to the SERIALIZEDPROPERTYVALUE buffer.

Remarks

This function deserializes a PROPVARIANT data type. This function is similar to the StgConvertPropertyToVariant function. The StgDeserializePropVariant function uses the default value of CP_WINUNICODE for the code page and a system provided allocator that uses task memory. Use StgDeserializePropVariant unless you want to specify which code page and memory allocator to use.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Propvarutil.h

Library

Propsys.lib

DLL

Propsys.dll

See also

StgConvertPropertyToVariant
StgSerializePropVariant

 

 

Community Additions

ADD
Show:
© 2014 Microsoft