StgSerializePropVariant function
The StgSerializePropVariant function converts a PROPVARIANT data type to a SERIALIZEDPROPERTYVALUE data type.
Syntax
HRESULT StgSerializePropVariant(
_In_ const PROPVARIANT *pVar,
_Out_ SERIALIZEDPROPERTYVALUE **ppProp,
_Out_ ULONG *pcb
);
Parameters
- pVar [in]
-
A pointer to PROPVARIANT.
- ppProp [out]
-
A pointer to the newly allocated SERIALIZEDPROPERTYVALUE.
- pcb [out]
-
A pointer to the size of the newly allocated SERIALIZEDPROPERTYVALUE.
Return value
This function can return one of these values.
- S_OK
-
Indicates that the PROPVARIANT was properly serialized.
- STATUS_INVALID_PARAMETER
-
Indicates that the value of pvar or ppProp is NULL.
- E_OUTOFMEMORY
-
Indicates that there was not enough memory to allocate for the SERIALIZEDPROPERTYVALUE.
Remarks
The StgSerializePropVariant function serializes a PROPVARIANT. The function is similar to the StgConvertVariantToProperty function, but the StgSerializePropVariant function automatically handles memory allocation for the new SERIALIZEDPROPERTYVALUE. In addition, StgSerializePropVariant uses the default values CP_WINUNICODE and PID_ILLEGAL for code page and property ID respectively. Use StgSerializePropVariant unless control over these arguments is specifically needed.
Requirements
|
Minimum supported client |
Windows 2000 Professional [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows 2000 Server [desktop apps only] |
|
Header |
|
|
Library |
|
|
DLL |
|
See also