Ticket #2737: _WinAPI_ShellGetStockIconInfo.txt

File _WinAPI_ShellGetStockIconInfo.txt, 1.4 KB (added by mLipok, 8 years ago)
Line 
1###User Defined Function###
2_WinAPI_ShellGetStockIconInfo
3
4###Description###
5Retrieves information about system-defined Shell icons
6
7###Syntax###
8#include <WinAPIShellEx.au3>
9_WinAPI_ShellGetStockIconInfo ( $iSIID, $iFlags )
10
11
12###Parameters###
13@@ParamTable@@
14$iSIID
15        One of the $SIID_* constants that specifies which icon should be retrieved.
16$iFlags
17        The flags that specify which information is requested. This parameter can be a combination of the following values:
18                $SHGSI_ICONLOCATION
19                $SHGSI_ICON
20                $SHGSI_SYSICONINDEX
21                $SHGSI_LINKOVERLAY
22                $SHGSI_SELECTED
23                $SHGSI_LARGEICON
24                $SHGSI_SMALLICON
25                $SHGSI_SHELLICONSIZE
26@@End@@
27
28###ReturnValue###
29@@ReturnTable@@
30Success:        $tagSHSTOCKICONINFO structure that contains the requested information.
31Failure:        Sets the @error flag to non-zero, @extended flag may contain the HRESULT error code.
32@@End@@
33
34
35###Remarks###
36$SIID_* , $SHGSI_* constants require #include <APIShellExConstants.au3>
37If this function returns an icon handle in the "hIcon" member of the $tagSHSTOCKICONINFO structure, you are
38responsible for freeing the icon with <a href="_WinAPI_DestroyIcon.htm">_WinAPI_DestroyIcon()</a> when you no longer need it.
39
40This function requires <strong>Windows Vista or later</strong>.
41
42
43###Related###
44_WinAPI_DestroyIcon
45
46
47###See Also###
48@@MsdnLink@@ SHGetStockIconInfo
49
50
51###Example###
52@@IncludeExample@@