OleLoadFromStream function (ole.h)

Article
02/22/2024

Loads an object from the stream.

Syntax

OLESTATUS OleLoadFromStream(
  LPOLESTREAM unnamedParam1,
  LPCSTR      unnamedParam2,
  LPOLECLIENT unnamedParam3,
  LHCLIENTDOC unnamedParam4,
  LPCSTR      unnamedParam5,
  LPOLEOBJECT *unnamedParam6
);

Parameters

unnamedParam1

TBD

unnamedParam2

TBD

unnamedParam3

TBD

unnamedParam4

TBD

unnamedParam5

TBD

unnamedParam6

TBD

Return value

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

Return code	Description
E_OUTOFMEMORY	Insufficient memory for the operation.
E_NOINTERFACE	The object does not support the specified interface.

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

Remarks

Important

Security Note: Calling this method with untrusted data is a security risk. Call this method only with trusted data.

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.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	ole.h (include Ole2.h)
Library	Ole32.lib
DLL	Ole32.dll
API set	ext-ms-win-com-ole32-l1-1-5 (introduced in Windows 10, version 10.0.15063)