IShellImageDataFactory::CreateImageFromFile method (shimgdata.h)

  • Article

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

Syntax

HRESULT CreateImageFromFile(
  [in]  LPCWSTR         pszPath,
  [out] IShellImageData **ppshimg
);

Parameters

[in] pszPath

Type: LPCWSTR

The path of the file containing the image. If this parameter is NULL, an unhandled exception results.

[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

An access violation occurs if pszPath is NULL.

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