|
M&M FDT 1.2.1 Online Specification |
Interfaces and Methods - Schemas - FDT Specification - Quicklinks - Abbreviations
2.7.2 IPersistStreamInit::Save()
| This method can be called in the states: |      |
|
HRESULT Save ( [in] LPSTREAM pStm, [in] BOOL fClearDirty ); |
Description:
Parameters:
| pStm | Points to the stream where the object is to be saved. |
| fClearDirty | Specifies whether to clear the dirty flag. |
Return Value:
Behavior:
| Saves an object to the specified stream. |
Comments:
| IPersistStreamInit::Save() saves an object into the specified stream and indicates whether the object should reset its dirty flag. The seek pointer is positioned at the location in the stream at which the object should begin writing its data. The object calls the ISequentialStream::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. Notes to Callers: Rather than calling IPersistStreamInit::Save() directly, you typically call the OleSaveToStream helper function which does the following: 1. Calls IPersistStreamInit::GetClassID to get the object's CLSID. 2. Calls the WriteClassStm function to write the object's CLSID to the stream. 3. Calls IPersistStreamInit::Save(). If you call these methods directly, you can write other data into the stream after the CLSID before calling IPersistStream::Save. The OLE-provided implementation of IPersistStreamInit follows this same pattern. Notes to Implementers: The IPersistStreamInit::Save() method does not write the CLSID to the stream. The caller is responsible for writing the CLSID. The IPersistStreamInit::Save() method can read from, write to, and seek in the stream; but it must not seek to a location in the stream before that of the seek pointer on entry. |
© by M&M Software GmbH, parts of this website taken from FDT Interface Specification Version 1.2.1, © by FDT Group, AISBL.
This website is published for support of M&M products as granted in license conditions, chapter 2.1.
Last updated 2015-02-05 15:17
Email: FDT Technical Support Line.