Click or drag to resize

ShellUtilitiesGetImageHandle Method (IWithIdList, Size, SIIGBF, Boolean)

Gets an HBITMAP handle that represents a Shell Item. The default behavior is to load a thumbnail. If there is no thumbnail for the current IShellItem, it retrieves an HBITMAP for the icon of the item. The thumbnail or icon is extracted if it is not currently cached.

Namespace:  ShellBoost.Core.Utilities
Assembly:  ShellBoost.Core (in ShellBoost.Core.dll) Version: 1.8.3.0
Syntax
C#
Copy
public static IntPtr GetImageHandle(
	IWithIdList idList,
	Size size,
	SIIGBF flags = SIIGBF.SIIGBF_RESIZETOFIT,
	bool throwOnError = true
)

Parameters

idList
Type: ShellBoost.CoreIWithIdList
The item's pidl.
size
Type: System.DrawingSize
The size of the image to be received.
flags (Optional)
Type: ShellBoost.Core.WindowsShellSIIGBF
Options that specify how the image will be extracted.
throwOnError (Optional)
Type: SystemBoolean
if set to true errors may be throw in case of Windows Shell errors.

Return Value

Type: IntPtr
An HBITMAP handle or IntPtr.Zero.
Exceptions
ExceptionCondition
ArgumentExceptionpidl is zero.
See Also