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

79 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_GetHostVersion" />
<meta name="DC.Relation" scheme="URI" content="rzaiksyslistcommapis2.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_gethostversion" />
<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_GetHostVersion</title>
</head>
<body id="cwbco_gethostversion"><a name="cwbco_gethostversion"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">cwbCO_GetHostVersion</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Get the version and release level of the
host.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
unsigned int CWB_ENTRY cwbCO_GetHostVersion(
LPCSTR system,
unsigned int * version,
unsigned int * release );</pre>
</div>
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">LPCSTR systemName - input</dt>
<dd>Pointer to a buffer that contains the system name.</dd>
<dt class="dlterm">unsigned int * version - output</dt>
<dd>Pointer to a buffer where the version level of the system is returned.</dd>
<dt class="dlterm">unsigned int * release - output</dt>
<dd>Pointer to a buffer where the release level of the system 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">CWBCO_SYSTEM_NOT_CONFIGURED</dt>
<dd>The system is not configured in the currently active environment.</dd>
<dt class="dlterm">CWBCO_SYSTEM_NOT_CONNECTED</dt>
<dd>The system has never been connected to when using the currently active
environment.</dd>
<dt class="dlterm">CWB_INVALID_POINTER</dt>
<dd>One of the pointers passed is NULL.</dd>
<dt class="dlterm">CWB_NOT_ENOUGH_MEMORY</dt>
<dd>Insufficient memory; may have failed to allocate temporary buffer.</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>The host version is retrieved and saved whenever
a connection is made to the system; this API does not go to the host to get
it on each call. The system must have been connected previously, though not
necessarily at the time the API is called. Host information can only be retrieved
for systems configured in the currently active environment.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaiksyslistcommapis2.htm" title="Use these APIs to obtain information about individual systems that are configured or connected in the current process. Unless the environment name is passed as a parameter, these APIs work only with the currently active environment.">Communications: System information APIs</a></div>
</div>
</div>
</body>
</html>