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

66 lines
3.8 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::GetItemCount" />
<meta name="DC.Relation" scheme="URI" content="rzakxia4hierarchyifspec.htm" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="rzakxia4hfgetitemcount" />
<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::GetItemCount</title>
</head>
<body id="rzakxia4hfgetitemcount"><a name="rzakxia4hfgetitemcount"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">IA4HierarchyFolder::GetItemCount</h1>
<div><p><strong>Purpose</strong></p>
<p>Returns the total count of objects contained in a particular folder in
the iSeries™ Navigator
hierarchy. This is a required member function.</p>
<p><strong>Syntax</strong></p>
<pre>HRESULT STDMETHODCALLTYPE GetItemCount(
ULONG* pCount
);</pre>
<p><strong>Parameters</strong></p>
<dl><dt class="dlterm">pCount</dt>
<dd>Pointer to a long integer that will receive the count of items in the
list.</dd>
</dl>
<p><strong>Return Codes</strong></p>
<p>Returns A4HYF_OK_LISTCOMPLETE if the list is completely built and the total
count of items is known. Returns A4HYF_OK_LISTNOTCOMPLETE if the list is still
being constructed; in this situation the item count represents the count of
items in the partially constructed list. Returns A4HYF_E_LISTDATAERROR if
an error is encountered while constructing the list. In this situation the
item count represents only the items that are already cached on the client.</p>
<p><strong>Comments</strong></p>
<p>Following a successful return from Activate, Navigator calls this function
to obtain the count of objects for the folder that is about to be populated.
Following the call to this function, Navigator repeatedly calls ItemAt to
obtain the item identifiers for the objects in the folder.</p>
<p>For extremely large lists, you may choose to return from Activate before
the entire list has been cached on the client. If this is the case, you should
return A4HYF_OK_LISTNOTCOMPLETE from GetItemCount. From that point on, GetItemCount
will be called by the iSeries Navigator every 10 seconds until A4HYF_OK_LISTCOMPLETE
or A4HYF_E_LISTDATAERROR is returned.</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>