This method loads an object from its existing storage.
At a Glance
Header file: | Oleidl.h |
Windows CE versions: | 2.0 and later |
Syntax
HRESULT Load( IStorage *pStg );
Parameters
pStg
[in] IStorage pointer to the existing storage from which the object is to be loaded.
Return Values
One of the values described in the following table is returned.
Value | Description |
S_OK | The object was successfully loaded. |
CO_E_ALREADYINITIALIZED | The object has already been initialized by a previous call to the IPersistStorage::Load method or the IPersistStorage::InitNew method. |
E_OUTOFMEMORY | The object was not loaded due to lack of memory. |
E_FAIL | The object was not loaded due to some reason besides a lack of memory. |
Remarks
This method initializes an object from an existing storage. The object is placed in the loaded state if this method is called by the container application. If called by the default handler, this method places the object in the running state.
Either the default handler or the object itself can hold onto the IStorage pointer while the object is loaded or running.
Notes to Callers
The container should cache the IPersistStorage pointer for use in later operations on the object.
Notes to Implementers
Your implementation should perform the following steps to load an object:
Steps 3 and 4 are particularly important for ensuring that the object can save itself in low memory situations. Holding onto pointers to the storage and stream interfaces guarantees that a save operation to this storage will not fail due to insufficient memory.
Your implementation of this method should return the CO_E_ALREADYINITIALIZED error code if it receives a call to either the IPersistStorage::InitNew method or the IPersistStorage::Load method after it is already initialized.