IPersistStorage::SaveCompleted (Compact 2013)
3/26/2014
This method notifies the object that it can revert from NoScribble or HandsOff mode, in which it must not write to its storage object, to Normal mode, in which it can.
Syntax
HRESULT SaveCompleted(
IStorage* pStgNew
);
Parameters
pStgNew
[in] IStorage pointer to the new storage object, if different from the storage object prior to saving.This pointer can be NULL if the current storage object does not change during the save operation.
If the object is in HandsOff mode, this parameter must be non-NULL.
Return Value
The following table shows the return values for this function.
Value |
Description |
|---|---|
S_OK |
The object was successfully returned to Normal mode. |
E_OUTOFMEMORY |
The object remained in HandsOff mode or NoScribble mode due to a lack of memory. Typically, this error occurs when the object is not able to open the necessary streams and storage objects in pStgNew. |
E_INVALIDARG |
The pStgNew parameter is not valid. Typically, this error occurs if pStgNew is NULL when the object is in HandsOff mode. |
E_UNEXPECTED |
The object is in Normal mode, and there was no previous call to the IPersistStorage::Save or IPersistStorage::HandsOffStorage methods. |
Remarks
This method notifies an object that it can revert to Normal mode and can once again write to its storage object. The object exits NoScribble mode or HandsOff mode.
If the object is reverting from HandsOff mode, the pStgNew parameter must be non-NULL.
In HandsOffFromNormal mode, this parameter is the new storage object that replaces the one that was revoked by the IPersistStorage::HandsOffStorage method. The data in the storage object is a copy of the data from the revoked storage object.
In HandsOffAfterSave mode, the data is the same as the data that was most recently saved. It is not the same as the data in the revoked storage object.
If the object is reverting from NoScribble mode, the pStgNew parameter can be NULL or non-NULL.
If NULL, the object once again has access to its storage object.
If it is not NULL, the component object should simulate receiving a call to its IPersistStorage::HandsOffStorage method.
If the component object cannot simulate this call, its container must be prepared to actually call the IPersistStorage::HandsOffStorage method.
The IPersistStorage::SaveCompleted method must recursively call any nested objects that are loaded or running.
If this method returns an error code, the object is not returned to Normal mode. Thus, the container object can attempt different save strategies.
To determine whether the platform supports this interface, see Determining Supported COM APIs.
Requirements
Header |
objidl.h, |
Library |
ole32.lib, |
See Also
Reference
IPersistStorage
IStorage
IPersistStorage::HandsOffStorage
IPersistStorage::Save