ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzaik_5.4.0.1/rzaikcwbsocreatelisthandleex.htm

103 lines
4.9 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="CWBSO_CreateListHandleEx" />
<meta name="DC.Relation" scheme="URI" content="rzaiksoaapilist.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="cwbso_createlisthandleex" />
<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>CWBSO_CreateListHandleEx</title>
</head>
<body id="cwbso_createlisthandleex"><a name="cwbso_createlisthandleex"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">CWBSO_CreateListHandleEx</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Creates a new list and returns a handle
to the list.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>unsigned int CWB_ENTRY CWBSO_CreateListHandleEx(
cwbCO_SysHandle systemObjectHandle,
CWBSO_LISTTYPE type,
CWBSO_LIST_HANDLE far* lpListHandle);</pre>
</div>
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">cwbCO_SysHandle systemObjectHandle - input</dt>
<dd>A handle to the system object that represents the iSeries™ system on which the list will
be built. The handle specified must be for a configured iSeries server.
</dd>
<dt class="dlterm">CWBSO_LISTTYPE</dt>
<dd>The type of list to be built. Specify one of the following: <dl><dt class="dlterm">CWBSO_LIST_JOB</dt>
<dd>List of jobs.</dd>
<dt class="dlterm">CWBSO_LIST_SJOB</dt>
<dd>List of server jobs.</dd>
<dt class="dlterm">CWBSO_LIST_SJOB</dt>
<dd>List of server jobs.</dd>
<dt class="dlterm">CWBSO_LIST_MSG</dt>
<dd>List of messages.</dd>
<dt class="dlterm">CWBSO_LIST_PRT</dt>
<dd>List of printers.</dd>
<dt class="dlterm">CWBSO_LIST_SFL</dt>
<dd>List of spooled files.</dd>
<dt class="dlterm">CWBSO_LIST_IFC</dt>
<dd>List interfaces.</dd>
<dt class="dlterm">CWBSO_LIST_ELN</dt>
<dd>List Ethernet lines.</dd>
<dt class="dlterm">CWBSO_LIST_TLN</dt>
<dd>List token-ring lines.</dd>
<dt class="dlterm">CWBSO_LIST_HWL</dt>
<dd>List hardware resources.</dd>
<dt class="dlterm">CWBSO_LIST_SW</dt>
<dd>List software products.</dd>
<dt class="dlterm">CWBSO_LIST_RTE</dt>
<dd>List TCP/IP route.</dd>
<dt class="dlterm">CWBSO_LIST_PRF</dt>
<dd>List user profiles.</dd>
<dt class="dlterm">CWBSO_LIST_SMP</dt>
<dd>List libraries in QSYS.</dd>
</dl>
</dd>
<dt class="dlterm">CWBSO_LIST_HANDLE far* lpListHandle - output</dt>
<dd>A long pointer to a handle that will be set to the handle for the newly
created list. This handle may be used with any other API that accepts a list
handle.</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">CWBSO_NO_ERROR</dt>
<dd>No error occurred.</dd>
<dt class="dlterm">CWBSO_BAD_LISTTYPE</dt>
<dd>The value that is specified for type of list is not valid.</dd>
<dt class="dlterm">CWBSO_LOW_MEMORY</dt>
<dd>Not enough memory is available for the request.</dd>
<dt class="dlterm">CWBSO_BAD_SYSTEM_NAME</dt>
<dd>The system name that is specified is not a valid iSeries system name.</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p>When the list is no longer needed, the calling
program is responsible for doing the following: </p>
<ul><li>Call <span class="apiname">CWBSO_DeleteListHandle</span> to free up resources that
are allocated on the client.</li>
</ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaiksoaapilist.htm" title="The following System Object Access APIs for iSeries Access for Windows are listed alphabetically.">System Object Access APIs for iSeries Access for Windows List</a></div>
</div>
</div>
</body>
</html>