78 lines
4.3 KiB
HTML
78 lines
4.3 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="cwbCO_CreateSysListHandleEnv" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaiksyslistcommapis1.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="cwbco_createsyslisthandleenv" />
|
||
|
|
<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>cwbCO_CreateSysListHandleEnv</title>
|
||
|
|
</head>
|
||
|
|
<body id="cwbco_createsyslisthandleenv"><a name="cwbco_createsyslisthandleenv"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1"><span class="apiname">cwbCO_CreateSysListHandleEnv</span></h1>
|
||
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Creates a handle to list of configured system
|
||
|
|
names of the specified environment.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
|
||
|
|
unsigned int CWB_ENTRY cwbCO_CreateSysListHandleEnv(
|
||
|
|
cwbCO_SysListHandle *listHandle,
|
||
|
|
cwbSV_ErrHandle errorHandle,
|
||
|
|
LPCSTR pEnvironment );</pre>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">cwbCO_SysListHandle *listHandle - output</dt>
|
||
|
|
<dd>Pointer to a list handle that will be passed back on output. This handle
|
||
|
|
is needed for other calls that are using the list.</dd>
|
||
|
|
<dt class="dlterm">cwbSV_ErrorHandle errorHandle - input</dt>
|
||
|
|
<dd>If the API call fails, the message object that is associated with this
|
||
|
|
handle will be filled in with message text that describes the error. If this
|
||
|
|
parameter is zero, no messages will be available.</dd>
|
||
|
|
<dt class="dlterm">LPCSTR pEnvironment</dt>
|
||
|
|
<dd>Pointer to a string containing the desired environment name. If pEnvironment
|
||
|
|
is the NULL pointer, or points to the NULL string ("\0"), the system list
|
||
|
|
of the current active environment is returned.</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_OK</dt>
|
||
|
|
<dd>Successful Completion.</dd>
|
||
|
|
<dt class="dlterm">CWB_NOT_ENOUGH_MEMORY</dt>
|
||
|
|
<dd>Insufficient memory; may have failed to allocate temporary buffer.</dd>
|
||
|
|
<dt class="dlterm">CWB_INVALID_POINTER</dt>
|
||
|
|
<dd>Pointer to the list handle is NULL.</dd>
|
||
|
|
<dt class="dlterm">CWBCO_NO_SUCH_ENVIRONMENT</dt>
|
||
|
|
<dd>The specified environment does not exist.</dd>
|
||
|
|
<dt class="dlterm">CWB_NON_REPRESENTABLE_UNICODE_CHAR</dt>
|
||
|
|
<dd>One or more input Unicode characters have no representation in the codepage
|
||
|
|
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><span class="apiname">cwbCO_DeleteSysListHandle</span> must
|
||
|
|
be called to free resources allocated with this API.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaiksyslistcommapis1.htm" title="Use these APIs to create a list of configured systems, either in the currently active environment or in a different environment. Retrieve the number of entries in the list, and each entry in succession.">Communications: Create and delete APIs</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|