IPersistStream::Load

Initializes an object from the stream where it was previously saved.

HRESULT Load(

IStream *pStm

//Pointer to the stream from which the object should be loaded

);

Parameter

pStm: [in]IStream pointer to the stream from which the object should be loaded.

Return Values

S_OK: The object was successfully loaded.
E_OUTOFMEMORY: The object was not loaded due to a lack of memory.
E_FAIL: The object was not loaded due to some reason other than a lack of memory.

Remarks

This method loads an object from its associated stream. The seek pointer is set as it was in the most recent IPersistStream::Save method. This method can seek and read from the stream, but cannot write to it.

On exit, the seek pointer must be in the same position it was in on entry, immediately past the end of the data.

Notes to Callers

Rather than calling IPersistStream::Load directly, you typically call the OleLoadFromStream function does the following:

Calls the ReadClassStm function to get the class identifier from the stream.
Calls the CoCreateInstance function to create an instance of the object.
Queries the instance for IPersistStream.
Calls IPersistStream::Load.

The OleLoadFromStream function assumes that objects are stored in the stream with a class identifier followed by the object data. This storage pattern is used by the generic, composite-moniker implementation provided by OLE.

If the objects are not stored using this pattern, you must call the methods separately yourself.

IStream *pStm	//Pointer to the stream from which the object should be loaded
);