OleLoad function

Loads into memory an object nested within a specified storage object.

Syntax

HRESULT OleLoad(
  IN LPSTORAGE       pStg,
  IN REFIID          riid,
  IN LPOLECLIENTSITE pClientSite,
  OUT LPVOID         *ppvObj
);

Parameters

pStg

Pointer to the IStorage interface on the storage object from which to load the specified object.

riid

Reference to the identifier of the interface that the caller wants to use to communicate with the object after it is loaded.

pClientSite

Pointer to the IOleClientSite interface on the client site object being loaded.

ppvObj

Address of pointer variable that receives the interface pointer requested in riid. Upon successful return, *ppvObj contains the requested interface pointer on the newly loaded object.

Return Value

This function returns S_OK on success. Other possible values include the following.

Return code Description
E_NOINTERFACE
The object does not support the specified interface.
 

Additionally, this function can return any of the error values returned by the IPersistStorage::Load method.

Remarks

OLE containers load objects into memory by calling this function. When calling the OleLoad function, the container application passes in a pointer to the open storage object in which the nested object is stored. Typically, the nested object to be loaded is a child storage object to the container's root storage object. Using the OLE information stored with the object, the object handler (usually, the default handler) attempts to load the object. On completion of the OleLoad function, the object is said to be in the loaded state with its object application not running.

Some applications load all of the object's native data. Containers often defer loading the contained objects until required to do so. For example, until an object is scrolled into view and needs to be drawn, it does not need to be loaded.

The OleLoad function performs the following steps:

Requirements

   
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header ole2.h
Library Ole32.lib
DLL Ole32.dll