IOleClientSite::SaveObject

This method saves an embedded object.

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 objects contents before the object closes itself. If a container instructs an object not to save itself, the object should not call SaveObject.

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.

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.