IExtractIconAExtract Method

Extracts an icon image from the specified location.

Definition

Namespace: DevCase.Win32.Interfaces
Assembly: DevCase.net48 (in DevCase.net48.dll) Version: 6.0.0.0 (6.0)
XMLNS for XAML: Not mapped to an xmlns.
[PreserveSigAttribute]
HResult Extract(
	string file,
	uint iconIndex,
	[OptionalAttribute] IntPtr iconLarge,
	[OptionalAttribute] IntPtr iconSmall,
	uint iconSize
)

Parameters

file  String
A string that specifies the icon location.
iconIndex  UInt32
The index of the icon in the file pointed to by file param.
iconLarge  IntPtr  (Optional)
A pointer to an HICON value that receives the handle to the large icon.

This parameter may be Zero.

iconSmall  IntPtr  (Optional)
A pointer to an HICON value that receives the handle to the small icon.

This parameter may be Zero.

iconSize  UInt32
The desired size of the icon, in pixels.

The low word contains the size of the large icon, and the high word contains the size of the small icon.

The size specified can be the width or height. The width of an icon always equals its height.

Return Value

HResult
Returns S_OK if the function extracted the icon, or S_FALSE if the calling application should extract the icon.

See Also