IA4HierarchyFolder::GetIconIndexOf

Purpose

Returns the index into the component resource DLL that may be used to load the icon for the hierarchy folder. This is a required member function.

Syntax

HRESULT STDMETHODCALLTYPE GetIconIndexOf(
    LPCITEMIDLIST pidl,
    UINT uFlags,
    int* piIndex
    );

Parameters

pidl

Pointer to an ITEMIDLIST (item identifier list) structure that uniquely identifies the object whose icon index is to be retrieved.

uFlags

This parameter may be zero, or it may contain the value GIL_OPENICON, indicating that the icon which should be supplied is an open folder. GIL_OPENICON is defined in the Windows^® include file SHLOBJ.H.

piIndex

Pointer to an integer that receives the icon index.

Return Codes

Returns NOERROR if successful or E_FAIL if unable to determine the index.

Comments

iSeries™ Navigator repeatedly calls this function when populating a tree or list view. Long running operations should therefore be avoided.