90 lines
5.2 KiB
HTML
90 lines
5.2 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="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="reference" />
|
||
|
|
<meta name="DC.Title" content="cwbOBJ_CreateListHandle" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikobjapilist1.htm" />
|
||
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 1999, 2006" />
|
||
|
|
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 1999, 2006" />
|
||
|
|
<meta name="DC.Format" content="XHTML" />
|
||
|
|
<meta name="DC.Identifier" content="cwbobj_createlisthandle" />
|
||
|
|
<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>cwbOBJ_CreateListHandle</title>
|
||
|
|
</head>
|
||
|
|
<body id="cwbobj_createlisthandle"><a name="cwbobj_createlisthandle"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1"><span class="apiname">cwbOBJ_CreateListHandle</span></h1>
|
||
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Allocates a handle for a list of objects.
|
||
|
|
After a list handle has been allocated, the filter criteria may be set for
|
||
|
|
the list with the <span class="apiname">cwbOBJ_SetListFilter()</span> API, the list
|
||
|
|
may be built with the <span class="apiname">cwbOBJ_OpenList()</span> API, etc. <span class="apiname">cwbOBJ_DeleteListHandle(</span>)
|
||
|
|
should be called to deallocated this list handle and free any resources used
|
||
|
|
by it.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
|
||
|
|
unsigned int CWB_ENTRY cwbOBJ_CreateListHandle(
|
||
|
|
const char *systemName,
|
||
|
|
cwbOBJ_ListType type,
|
||
|
|
cwbOBJ_ListHandle *listHandle,
|
||
|
|
cwbSV_ErrHandle errorHandle);</pre>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">const char *systemName - input</dt>
|
||
|
|
<dd>Pointer to the system name contained in ASCIIZ string</dd>
|
||
|
|
<dt class="dlterm">cwbOBJ_ListType type - input</dt>
|
||
|
|
<dd>Type of list to allocate (eg. spooled file list, output queue list, etc).</dd>
|
||
|
|
<dt class="dlterm">cwbOBJ_ListHandle *listHandle - output</dt>
|
||
|
|
<dd>Pointer to a list handle that will be passed back on output. This handle
|
||
|
|
is needed for other calls using the list.</dd>
|
||
|
|
<dt class="dlterm">cwbSV_ErrHandle errorHandle - output</dt>
|
||
|
|
<dd>Optional, may be 0. Any returned messages will be written to this object.
|
||
|
|
It is created with the <span class="apiname">cwbSV_CreateErrHandle()</span> API. The
|
||
|
|
messages may be retrieved through the <span class="apiname">cwbSV_GetErrText()</span> API.
|
||
|
|
If the parameter is set to zero, no messages will be retrievable.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Return Codes</h4><p>The following list shows common return
|
||
|
|
values.</p>
|
||
|
|
<dl><dt class="dlterm">CWB_NO_ERROR</dt>
|
||
|
|
<dd>Successful completion.</dd>
|
||
|
|
<dt class="dlterm">CWB_NOT_ENOUGH_MEMORY</dt>
|
||
|
|
<dd>Insufficient memory.</dd>
|
||
|
|
<dt class="dlterm">CWB_NON_REPRESENTABLE_UNICODE_CHAR</dt>
|
||
|
|
<dd>One or more input Unicode characters have no representation in the codepage
|
||
|
|
that is being used.</dd>
|
||
|
|
<dt class="dlterm">CWB_API_ERROR</dt>
|
||
|
|
<dd>General API failure.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4><p>Caller must call <span class="apiname">cwbOBJ_DeleteListHandle</span> when
|
||
|
|
done using this list handle. Typical calling sequence for retrieving a list
|
||
|
|
of objects would be:</p>
|
||
|
|
<ol><li><span class="apiname">cwbOBJ_CreateListHandle()</span></li>
|
||
|
|
<li><span class="apiname">cwbOBJ_SetListFilter()</span> { repeated as needed }</li>
|
||
|
|
<li><span class="apiname">cwbOBJ_OpenList()</span></li>
|
||
|
|
<li><span class="apiname">cwbOBJ_GetListSize()</span> to get the size of the list.</li>
|
||
|
|
<li>For n=0 to list size - 1 <span class="apiname">cwbOBJ_GetObjHandle</span> for list
|
||
|
|
item in position n do something with the object <span class="apiname">cwbOBJ_DeleteObjHandle()</span></li>
|
||
|
|
<li><span class="apiname">cwbOBJ_CloseList()</span> - You may go back to step 2 here.</li>
|
||
|
|
<li><span class="apiname">cwbOBJ_DeleteListHandle()</span></li>
|
||
|
|
</ol>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikobjapilist1.htm" title="The following iSeries Access for Windows APIs pertain to List objects. The APIs are listed alphabetically.">List APIs for iSeries Access for Windows</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|