ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzakx_5.4.0.1/rzakxia4hfgettoolbarinfo.htm

72 lines
4.0 KiB
HTML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="copyright" content="(C) Copyright IBM Corporation 2005" />
<meta name="DC.rights.owner" content="(C) Copyright IBM Corporation 2005" />
<meta name="security" content="public" />
<meta name="Robots" content="index,follow" />
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
<meta name="DC.Type" content="concept" />
<meta name="DC.Title" content="IA4HierarchyFolder::GetToolBarInfo" />
<meta name="DC.Relation" scheme="URI" content="rzakxia4hierarchyifspec.htm" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="rzakxia4hfgettoolbarinfo" />
<meta name="DC.Language" content="en-us" />
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
<link rel="stylesheet" type="text/css" href="./ic.css" />
<title>IA4HierarchyFolder::GetToolBarInfo</title>
</head>
<body id="rzakxia4hfgettoolbarinfo"><a name="rzakxia4hfgettoolbarinfo"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">IA4HierarchyFolder::GetToolBarInfo</h1>
<div><p><strong>Purpose</strong></p>
<p>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.</p>
<p><strong>Syntax</strong></p>
<pre>HRESULT STDMETHODCALLTYPE GetToolBarInfo(
LPCITEMIDLIST pidl,
LPVOID* ppvInfo
);</pre>
<p><strong>Parameters</strong></p>
<dl><dt class="dlterm">pidl</dt>
<dd>Pointer to an ITEMIDLIST (item identifier list) structure that uniquely
identifies the object for which tool bar information is to be retrieved.</dd>
<dt class="dlterm">ppvInfo</dt>
<dd>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.</dd>
</dl>
<p><strong>Return Codes</strong></p>
<p>Returns NOERROR if successful or E_NOTIMPL if you choose not to implement
the function.</p>
<p><strong>Comments</strong></p>
<p>This function is called each time a user selects a folder or object that
belongs to an iSeries Navigator
plug-in.</p>
<p>Use the Windows<sup>®</sup> IMalloc interface to allocate memory for
the returned structure. The Navigator will be responsible for deleting this
memory.</p>
<p>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.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzakxia4hierarchyifspec.htm" title="An item identifier, or data entity, identifies all folders and objects in the Windows namespace. Item identifiers are like filenames in a hierarchical file system. The Windows namespace is, in fact, a hierarchical namespace with its root at the Desktop.">IA4HierarchyFolder interface specifications listing</a></div>
</div>
</div>
</body>
</html>