Share via


IPersistStreamInit::Save Method

This method should save object data to the specified stream.

HRESULT Save(
    LPSTREAM pStm,
    BOOL fClearDirty
);

Parameters

  • pStm
    [in] A pointer to a stream in which to save the object data.

  • fClearDirty
    [in] A BOOL value indicating whether or not to clear the IsDirty flag. If TRUE, the flag should be cleared. If FALSE, the flag should be left unchanged.

Return Value

This method must return the HRESULT value S_OK to indicate success, and should generally return one of the standard COM error values to indicate failure.

Remarks

The seek pointer is positioned at the location in the stream at which the object should begin writing its data. The object calls the IStream::Write method to write its data.

On exit, the seek pointer must be positioned immediately past the object data. The position of the seek pointer is undefined if an error returns.

See Also

Other Resources

IPersistStreamInit Interface

IPersistStreamInit::Load Method