81 lines
4.2 KiB
HTML
81 lines
4.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="cwbCO_GetEnvironmentName" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaiksyslistcommapis3.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_getenvironmentname" />
|
||
|
|
<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_GetEnvironmentName</title>
|
||
|
|
</head>
|
||
|
|
<body id="cwbco_getenvironmentname"><a name="cwbco_getenvironmentname"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1"><span class="apiname">cwbCO_GetEnvironmentName</span></h1>
|
||
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Get the name of the environment corresponding
|
||
|
|
to the index.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
|
||
|
|
unsigned int CWB_ENTRY cwbCO_GetEnvironmentName(
|
||
|
|
char *environmentName,
|
||
|
|
unsigned long *bufferSize,
|
||
|
|
unsigned long index);</pre>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">char *environmentName - output</dt>
|
||
|
|
<dd>Pointer to a buffer that will contain the environment name. This buffer
|
||
|
|
should be large enough to hold at least CWBCO_MAX_ENV_NAME + 1 characters,
|
||
|
|
including the terminating NULL character.</dd>
|
||
|
|
<dt class="dlterm">unsigned long * bufferSize - input/output</dt>
|
||
|
|
<dd> <dl><dt class="dlterm">input</dt>
|
||
|
|
<dd>Size of the buffer pointed to by *environmentName.</dd>
|
||
|
|
<dt class="dlterm">output</dt>
|
||
|
|
<dd>Size of buffer needed, if the buffer provided was too small.</dd>
|
||
|
|
</dl>
|
||
|
|
</dd>
|
||
|
|
<dt class="dlterm">unsigned long index - input</dt>
|
||
|
|
<dd>0 corresponds to the first environment.</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_INVALID_POINTER</dt>
|
||
|
|
<dd>One or more pointer parameters are NULL.</dd>
|
||
|
|
<dt class="dlterm">CWB_BUFFER_OVERFLOW</dt>
|
||
|
|
<dd>Not enough room in output buffer to hold entire environment name. Use
|
||
|
|
*bufferSize to determine the correct size. No error message is logged to the
|
||
|
|
History Log since the caller is expected to recover from this error and continue.</dd>
|
||
|
|
<dt class="dlterm">CWBCO_END_OF_LIST</dt>
|
||
|
|
<dd>The end of the environments list has been reached. No environment name
|
||
|
|
was returned. </dd>
|
||
|
|
<dt class="dlterm">CWB_NOT_ENOUGH_MEMORY</dt>
|
||
|
|
<dd>Insufficient memory; may have failed to allocate temporary buffer.</dd>
|
||
|
|
<dt class="dlterm">CWB_API_ERROR</dt>
|
||
|
|
<dd>General API failure.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4><p>None.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaiksyslistcommapis3.htm" title="Use these APIs to obtain the names of environments that have been configured.">Communications: Configured environments information</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|