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

78 lines
4.4 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_GetHostVersionEx" />
<meta name="DC.Relation" scheme="URI" content="rzaikcommapilist4.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_gethostversionex" />
<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_GetHostVersionEx</title>
</head>
<body id="cwbco_gethostversionex"><a name="cwbco_gethostversionex"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">cwbCO_GetHostVersionEx</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>
UINT CWB_ENTRY cwbCO_GetHostVersionEx(
cwbCO_SysHandle system,
PULONG version,
PULONG release);</pre>
</div>
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">cwbCO_SysHandle system - input</dt>
<dd>Handle that previously was returned from <span class="apiname">cwbCO_CreateSystem</span> or <span class="apiname">cwbCO_CreateSystemLike</span>.
It identifies the iSeries™ system.</dd>
<dt class="dlterm">PULONG version - output</dt>
<dd>Pointer to a buffer where the version level of the system is returned.</dd>
<dt class="dlterm">PULONG 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">CWB_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 in is NULL.</dd>
<dt class="dlterm">CWB_NOT_ENOUGH_MEMORY</dt>
<dd>Insufficient memory; may have failed to allocate a temporary buffer.</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 iSeries system. If no connection has been made yet
to this iSeries system
in the currently-active environment, this information will not be available,
and the error code CWB_NOT_CONNECTED will be returned. If you know that a
connection to the iSeries system recently was made successfully, it
is likely that the version and release levels returned are current. If you
want to make sure that the values are available and recently have been retrieved,
call <span class="apiname">cwbCO_Signon</span> or <span class="apiname">cwbCO_Connect</span> for
this system object first, then call <span class="apiname">cwbCO_GetHostVersionEx</span>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikcommapilist4.htm" title="Use the APIs to get and set other system object attributes, or determine if the attributes are restricted by policies.">Communications and security: Get and set attribute APIs</a></div>
</div>
</div>
</body>
</html>