Edit

IShellImageDataFactory::CreateImageFromStream method (shimgdata.h)

  • Article

Creates an instance of the IShellImageData interface based on a given file stream.

Syntax

HRESULT CreateImageFromStream(
  [in]  IStream         *pStream,
  [out] IShellImageData **ppshimg
);

Parameters

[in] pStream

Type: IStream*

A pointer to the image stream.

[out] ppshimg

Type: IShellImageData**

The address of a pointer to an instance of IShellImageData.

Return value

Type: HRESULT

Returns S_OK if successful, or an error value otherwise, including the following:

Return code Description
E_OUTOFMEMORY
 The internal object cannot be instantiated.
E_NOINTERFACE
 The internal object does not support the IShellImageData or IPersistFile interfaces.
E_POINTER
 The ppshimg parameter is NULL.

Remarks

If pStream is NULL or an invalid pointer, later calls to Decode will cause an access violation.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header shimgdata.h
DLL Shell32.dll