IPersistStorage::Save
This method saves an object and any nested objects that it contains into the specified storage. The object is placed in NoScribble mode and must not write to the specified storage until it receives a call to its IPersistStorage::SaveCompleted method.
HRESULT Save(
IStorage *pStgSave,
BOOL fSameAsLoad);
Parameters
pStgSave
[in] IStorage pointer to the storage into which the object is to be saved.fSameAsLoad
[in] Boolean value that indicates whether the specified storage is the current one, which was passed to the object by one of the following calls:- IPersistStorage::InitNew when it was created.
- IPersistStorage::Load when it was loaded.
- IPersistStorage::SaveCompleted when it was saved to a storage different from its current storage.
This parameter is set to FALSE when performing a Save As or Save A Copy To operation or when performing a full save. In the latter case, this method saves to a temporary file, deletes the original file, and renames the temporary file.
This parameter is set to TRUE to perform a full save in a low-memory situation or to perform a fast incremental save in which only the dirty components are saved.
Return Values
One of the values described in the following table is returned.
| Value | Description |
|---|---|
| S_OK | The object was successfully saved. |
| STG_E_MEDIUMFULL | The object was not saved because of a lack of space on the disk. |
| E_FAIL | The object could not be saved due to errors other than a lack of disk space. |
Remarks
This method saves an object, and any nested objects it contains, into the specified storage. It also places the object into NoScribble mode. Thus, the object cannot write to its storage until a subsequent call to the IPersistStorage::SaveCompleted method returns the object to Normal mode.
If the storage object is the same as the one it was loaded or created from, the save operation may be able to write incremental changes to the storage object. Otherwise, a full save must be done.
This method recursively calls the IPersistStorage::Save method, the OleSave function, or the IStorage::CopyTo method to save its nested objects.
This method does not call the IStorage::Commit method. Nor does it write the CLSID to the storage object. Both of these tasks are the responsibilities of the caller.
Notes to Callers
Rather than calling IPersistStorage::Save directly, you typically call the OleSave helper function which performs the following steps:
- Call the WriteClassStg function to write the class identifier for the object to the storage.
- Call the IPersistStorage::Save method.
- If needed, call the IStorage::Commit method on the storage object.
Then, a container application performs any other operations necessary to complete the save and calls the SaveCompleted method for each object.
If an embedded object passes the IPersistStorage::Save method to its nested objects, it must receive a call to its IPersistStorage::SaveCompleted method before calling this method for its nested objects.
Requirements
| Runs On | Versions | Defined in | Include | Link to |
|---|---|---|---|---|
| Windows CE OS | 2.0 and later | Oleidl.h |
Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.
See Also
OleSave, WriteClassStg, IStorage, IPersistStorage::InitNew, IPersistStorage::Load, IPersistStorage::SaveCompleted, IStorage::Commit
Last updated on Tuesday, July 13, 2004
© 1992-2000 Microsoft Corporation. All rights reserved.