IOleClientSite::SaveObject

This method saves an embedded object.

At a Glance

Syntax

HRESULT SaveObject( void );

Return Values

This method supports the standard return value E_FAIL, as well as S_OK, which indicates that the object was saved.

Remarks

An embedded object calls IOleClientSite::SaveObject to ask its container to save it to persistent storage when an end user chooses the File Update or Exit commands. The call is synchronous, meaning that by the time it returns, the save operation will be completed.

Calls to IOleClientSite::SaveObject occur in most implementations of IOleObject::Close. Usually, when a container tells an object to close, the container passes a flag specifying whether the object should save itself before closing, prompt the user for instructions, or close without saving itself. If an object is instructed to save itself, either by its container or an end user, it calls IOleClientSite::SaveObject to ask the container application to save the object’s contents before the object closes itself. If a container instructs an object not to save itself, the object should not call SaveObject.