Show/Hide TOC

IExtractIconAGetIconLocation Method

Gets the location and index of an icon.

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.

C#Request Example

[PreserveSigAttribute]
HResult GetIconLocation(
	GetIconLocationFlags flags,
	StringBuilder iconFile,
	int iconFileBuffer,
	ref int refIndex,
	ref GetIconLocationResultFlags refFlags
)

VBRequest Example

<PreserveSigAttribute>
Function GetIconLocation ( 
	flags As GetIconLocationFlags,
	iconFile As StringBuilder,
	iconFileBuffer As Integer,
	ByRef refIndex As Integer,
	ByRef refFlags As GetIconLocationResultFlags
) As HResult

Dim instance As IExtractIconA
Dim flags As GetIconLocationFlags
Dim iconFile As StringBuilder
Dim iconFileBuffer As Integer
Dim refIndex As Integer
Dim refFlags As GetIconLocationResultFlags

Dim returnValue As HResult

returnValue = instance.GetIconLocation(flags, 
	iconFile, iconFileBuffer, refIndex, 
	refFlags)

C++Request Example

[PreserveSigAttribute]
HResult GetIconLocation(
	GetIconLocationFlags flags, 
	StringBuilder^ iconFile, 
	int iconFileBuffer, 
	int% refIndex, 
	GetIconLocationResultFlags% refFlags
)

F#Request Example

[<PreserveSigAttribute>]
abstract GetIconLocation : 
        flags : GetIconLocationFlags * 
        iconFile : StringBuilder * 
        iconFileBuffer : int * 
        refIndex : int byref * 
        refFlags : GetIconLocationResultFlags byref -> HResult

ASP.NETRequest Example

No code example is currently available or this language may not be supported.

Parameters

flags GetIconLocationFlags: GetIconLocationFlags flags.
This value can be Null.
iconFile StringBuilder: A pointer to a buffer that receives the icon location.
The icon location is a null-terminated string that identifies the file that contains the icon.
iconFileBuffer Int32: The size of the buffer, in characters, pointed to by iconFile param.
refIndex Int32: Receives the index of the icon in the file pointed to by iconFile param.
refFlags GetIconLocationResultFlags: Receives Null or a combination of GetIconLocationResultFlags flags.

Return Value

HResult
Returns S_OK if the function returned a valid location, or S_FALSE if the Shell should use a default icon.

If the Async flag is set in flags param, the method can return E_PENDING to indicate that icon extraction will be time-consuming.

IExtractIconAGetIconLocation Method

Definition

Parameters

Return Value

See Also

Reference