IAssocHandler::GetIconLocation method (shobjidl_core.h)

Article
02/22/2024

Retrieves the location of the icon associated with the application.

Syntax

HRESULT GetIconLocation(
  [out] LPWSTR *ppszPath,
  [out] int    *pIndex
);

Parameters

[out] ppszPath

Type: LPWSTR*

When this method returns, contains the address of a pointer to a null-terminated, Unicode string that contains the path to the application's icon.

[out] pIndex

Type: int*

When this method returns, contains a pointer to the index of the icon within the resource named in ppszPath.

Return value

Type: HRESULT

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

Remarks

If the icon cannot be found, the function will return the path to the executable, and an icon index of zero.

For performance reasons, an application may use the Shell image cache to retrieve the icon, rather than loading the icon directly from the path returned. The path and icon index can be passed directly to Shell_GetCachedImageIndex. One benefit of this is that the Shell cache can provide a default icon in the event that no icon was available for the application.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	shobjidl_core.h (include Shobjidl.h)

Share via