Skip to content

Latest commit

 

History

History
105 lines (73 loc) · 4.13 KB

nf-shobjidl_core-ishelliconoverlayidentifier-getoverlayinfo.md

File metadata and controls

105 lines (73 loc) · 4.13 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:shobjidl_core.IShellIconOverlayIdentifier.GetOverlayInfo
IShellIconOverlayIdentifier::GetOverlayInfo (shobjidl_core.h)
Provides the location of the icon overlay's bitmap.
GetOverlayInfo
GetOverlayInfo method [Windows Shell]
GetOverlayInfo method [Windows Shell]
IShellIconOverlayIdentifier interface
ISIOI_ICONFILE
ISIOI_ICONINDEX
IShellIconOverlayIdentifier interface [Windows Shell]
GetOverlayInfo method
IShellIconOverlayIdentifier.GetOverlayInfo
IShellIconOverlayIdentifier::GetOverlayInfo
_win32_IShellIconOverlayIdentifier_GetOverlayInfo
shell.IShellIconOverlayIdentifier_GetOverlayInfo
shobjidl_core/IShellIconOverlayIdentifier::GetOverlayInfo
shell\IShellIconOverlayIdentifier_GetOverlayInfo.htm
shell
301dc569-738f-454f-9063-223ea6632e55
12/05/2018
GetOverlayInfo, GetOverlayInfo method [Windows Shell], GetOverlayInfo method [Windows Shell],IShellIconOverlayIdentifier interface, ISIOI_ICONFILE, ISIOI_ICONINDEX, IShellIconOverlayIdentifier interface [Windows Shell],GetOverlayInfo method, IShellIconOverlayIdentifier.GetOverlayInfo, IShellIconOverlayIdentifier::GetOverlayInfo, _win32_IShellIconOverlayIdentifier_GetOverlayInfo, shell.IShellIconOverlayIdentifier_GetOverlayInfo, shobjidl_core/IShellIconOverlayIdentifier::GetOverlayInfo
shobjidl_core.h
Shlobj.h
Windows
Windows 2000 Professional, Windows XP [desktop apps only]
Windows Server 2003 [desktop apps only]
Shell32.dll (version 5.0 or later)
Windows
19H1
IShellIconOverlayIdentifier::GetOverlayInfo
shobjidl_core/IShellIconOverlayIdentifier::GetOverlayInfo
c++
APIRef
kbSyntax
COM
Shell32.dll
IShellIconOverlayIdentifier.GetOverlayInfo

IShellIconOverlayIdentifier::GetOverlayInfo

-description

Provides the location of the icon overlay's bitmap.

-parameters

-param pwszIconFile [out]

Type: PWSTR

A null-terminated Unicode string that contains the fully qualified path of the file containing the icon. The .dll, .exe, and .ico file types are all acceptable. You must set the ISIOI_ICONFILE flag in pdwFlags if you return a file name.

-param cchMax

Type: int

The size of the pwszIconFile buffer, in Unicode characters.

-param pIndex [out]

Type: int*

Pointer to an index value used to identify the icon in a file that contains multiple icons. You must set the ISIOI_ICONINDEX flag in pdwFlags if you return an index.

-param pdwFlags [out]

Type: DWORD*

Pointer to a bitmap that specifies the information that is being returned by the method. This parameter can be one or both of the following values.

ISIOI_ICONFILE (0x00000001)

The path of the icon file is returned through pwszIconFile.

ISIOI_ICONINDEX (0x00000002)

There is more than one icon in pwszIconFile. The icon's index is returned through pIndex.

-returns

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

-remarks

This method is called by the Shell at startup so that the handler's icon overlay can be added to the system image list. After initialization is complete, the Shell calls GetOverlayInfo when it needs to display the handler's icon overlay.

Note  Once the image has been loaded into the system image list during initialization, it cannot be changed. After initialization, the file name and index are used only to identify the icon overlay. The system will not load a new icon overlay. When GetOverlayInfo is called, your handler must return the same file name and index that were specified when the function was first called.