OleSave

This function saves an object opened in transacted mode into the specified storage object.

At a Glance

Syntax

WINOLEAPI OleSave( IPersistStorage * pPS, IStorage * pStg,
BOOL fSameAsLoad );

Parameters

pPS

[in] Pointer to the IPersistStorage interface on the object to be saved.

pStg

[in] Pointer to the IStorage interface on the destination storage object to which the object indicated in pPS is to be saved.

fSameAsLoad

[in] Boolean that is set to TRUE if pStg is the same storage object from which the object was loaded or created, or to FALSE if pstg was loaded or created from a different storage object.

Return Values

S_OK

The object was successfully saved.

STG_E_MEDIUMFULL

The object could not be saved due to lack of disk space.

This function can also return any of the error values returned by the IPersistStorage::Save method.

Remarks

Passing into this function any invalid and, under some circumstances, NULL pointers will result in unexpected termination of the application.

The OleSave helper function handles the common situation in which an object is open in transacted mode and is then to be saved into the specified storage object which uses the OLE-provided compound file implementation. Transacted mode means that changes to the object are buffered until either of the IStorage methods Commit or Revert is called. Callers can handle other situations by calling the IPersistStorage and IStorage interfaces directly.

OleSave does the following:

1. Calls the IPersistStorage::GetClassID method to get the CLSID of the object.
   
   
2. Writes the CLSID to the storage object using the WriteClassStg function.
   
   
3. Calls the IPersistStorage::Save method to save the object.
   
   
4. If there were no errors on the save; calls the IStorage::Commit method to commit the changes.

Note

Static objects are saved into a stream called CONTENTS. Static metafile objects get saved in "placeable metafile format" and static DIB data gets saved in "DIB file format." These formats are defined to be the OLE standards for metafile and DIB. All data transferred using an IStream interface or a file transferred using IDataObject::GetDataHere must be in these formats. Also, all objects whose default file format is a metafile or DIB must write their data into a CONTENTS stream using these standard formats.