IA4HierarchyFolder::GetToolBarInfo

Purpose

Returns a structure that describes the custom tool bar that is associated with the specified folder in the iSeries™ Navigator hierarchy. This is a required member function.

Syntax

HRESULT STDMETHODCALLTYPE GetToolBarInfo(
    LPCITEMIDLIST pidl,
    LPVOID* ppvInfo
    );

Parameters

pidl

Pointer to an ITEMIDLIST (item identifier list) structure that uniquely identifies the object for which tool bar information is to be retrieved.

ppvInfo

The returned data structure. An instance of A4hyfToolBarInfo should be returned in this pointer. This structure supplies the count of toolbar buttons for the object, the address of an array of TBBUTTON structures containing the attributes for each button, and the instance handle of the plug-in. Refer to CWBA4HYF.H.

Return Codes

Returns NOERROR if successful or E_NOTIMPL if you choose not to implement the function.

Comments

This function is called each time a user selects a folder or object that belongs to an iSeries Navigator plug-in.

Use the Windows^® IMalloc interface to allocate memory for the returned structure. The Navigator will be responsible for deleting this memory.

If this member function is not implemented, the default iSeries Navigator tool bar will be used. This toolbar contains Copy, Paste, Delete, Properties, buttons for the four list views, and Refresh. The iSeries Navigator calls the implementation of IContextMenu::GetCommandString (with the GCS_VALIDATE flag set) that is in your product to discover which of the toolbar buttons should be enabled for your objects.