Edit

IShellImageStore::GetEntry method (shlobj.h)

  • Article

[IShellImageStore is supported through Windows XP. It is not supported in later operating systems.]

Gets a handle to an image in the cache.

Syntax

HRESULT GetEntry(
  [in]  PCWSTR  pszName,
        DWORD   dwMode,
  [out] HBITMAP *phImage
);

Parameters

[in] pszName

Type: PCWSTR

A pointer to a null-terminated string that specifies the path to the file that contains the image.

dwMode

Type: DWORD

The storage instantiation mode specified by one of the STGM values.

[out] phImage

Type: HBITMAP*

A pointer to the handle of the bitmap.

Return value

Type: HRESULT

Returns the result of ISequentialStream::Read if the process was successful. Otherwise, returns one of the following values:

Return code Description
E_UNEXPECTED
 Storage is not open.
E_FAIL
 The stream cannot be found.

Remarks

It is the caller's responsibility to free the handle after a call to this method.

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 shlobj.h
DLL Shell32.dll (version 5.0 or later)