IPersistHistory::SaveHistory Method

---

Saves the state of a component.

Syntax

HRESULT SaveHistory(
    IStream *pStream
);

Parameters

pStream

[in] Address of the stream into which the object should save its persistent state.

Return Value

Returns one of the following values:

S_OK	The component successfully saved its state to the supplied stream.
E_FAIL	The component was unable to save its state.
E_POINTER	The stream pointer was invalid.

Remarks

The container calls SaveHistory to request that the component save its state.

The component should under no circumstances add a reference to the supplied stream. The stream should not be cached by the component.