Share via

OleLoadFromStream

  • Article

This function loads an object from the stream.

WINOLEAPI OleLoadFromStream(
  IStream* pStm,
  REFIID iidInterface,
  void** ppvObj
);

Parameters

  • pStm
    [in] Pointer to the IStream interface on the stream from which the object is to be loaded.
  • iidInterface
    [in] Interface identifier (IID) the caller wants to use to communicate with the object once it is loaded.
  • ppvObj
    [out] 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 Values

The following table shows the HRESULT values that can be returned by this function.

Value Description
S_OK The object was successfully loaded.
E_NOINTERFACE The specified interface is not supported.
E_OUTOFMEMORY The function failed.

This function can also return any of the error values returned by the ReadClassStm and CoCreateInstance functions, and the IPersistStorage::Load method.

Remarks

This function can be used to load an object that supports the IPersistStream interface. The CLSID of the object must immediately precede the object's data in the stream, which is accomplished by the companion function OleSaveToStream or the operations it wraps, which are described under that topic.

If the CLSID for the stream is CLSID_NULL, the ppvObj parameter is set to NULL.

To determine whether the platform supports this function, see Determining Supported COM APIs.

Requirements

OS Versions: Windows CE 2.0 and later.
Header: Ole2.h.
Link Library: Ole32.lib.

See Also

IStream | ReadClassStm | CoCreateInstance | IPersistStorage::Load | IPersistStream | OleSaveToStream | Determining Supported COM APIs

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.