IExtractIcon::GetIconLocation

[Now Supported on Windows NT]

Retrieves the location and index of an icon.

HRESULT GetIconLocation(

UINT uFlags,	//Status values
LPSTR szIconFile,	//Address of buffer receiving icon location
INT cchMax,	//Size of buffer receiving icon location
int *piIndex,	//Pointer that receivs the icon index
UINT *pwFlags	//Pointer to zero or more values
);

Parameters

uFlags

Flags. This parameter can be zero or the following values:

GIL_FORSHELL	The icon is to be displayed in a shell folder.
GIL_OPENICON	The icon should be in the "open" state if both open- and closed-state images are available. If this flag is not specified the icon should be in the normal or "closed" state. This flag is typically used for folder objects.

szIconFile and cchMax

Address of the buffer that receives the icon location. The icon location is a null-terminated string that identifies the location of the icon.

cchMax

Size of the buffer that receives the icon location.

piIndex

Pointer to an integer that receives the icon index, which further describes the icon location.

pwFlags

Pointer to an unsigned integer that receives zero or more of the following values:

GIL_DONTCACHE	The physical image bits for this icon should not be cached by the caller. This distinction is important to consider because a GIL_DONTCACHELOCATION flag may be introducted in future versions of the shell..
GIL_NOTFILENAME	The location is not a filename/index pair. Callers that decide to extract the icon from the location must call this object's IExtractIcon::Extract method to obtain the desired icon images.
GIL_PERCLASS	All objects of this class have the same icon. This flag is used internally by the shell. Typical implementations of IExtractIcon do not require this flag because it implies that an icon handler is not required to resolve the icon on a per-object basis. the recommended method for implementing per-class icons is to register a DefaultIcon for the class.
GIL_PERINSTANCE	Each object of this class has its own icon. Used internally by the shell to handle cases like setup.exe where more than one object with identical names could be known to the shell and have different icons. Typical implementations of IExtractIcon do not require this flag.
GIL_SIMULATEDOC	The caller should create a document icon using the specified icon.

Return Values

Returns NOERROR if the function returned a valid location or S_FALSE if the shell should use a default icon.

See Also

IExtractIcon, IExtractIcon::Extract

Software for developers

Delphi Components
.Net Components
Software for Android Developers

More information resources

MegaDetailed.Net
Unix Manual Pages
Delphi Examples

Databases for Amazon shops developers

Amazon Categories Database
Browse Nodes Database