ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/qscchkct.htm

172 lines
4.6 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Check Communications Trace (QSCCHKCT) API</title>
<!-- Begin Header Records ========================================== -->
<!-- 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. -->
<!-- Created 08/08/2001 for XPF DCR 98660 by Rick Vaughan -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<a name="Top_Of_Page"></a>
<!-- Java sync-link -->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<h2>Check Communications Trace (QSCCHKCT) API</h2>
<div class="box" style="width: 80%;">
<br>
&nbsp;&nbsp;Required Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="50%">Storage allocated</td>
<td align="left" valign="top" width="20%">Output</td>
<td align="left" valign="top" width="20%">Binary(8)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Storage in use</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">Binary(8)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Error code</td>
<td align="left" valign="top">I/O</td>
<td align="left" valign="top">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Check Comunications Trace (QSCCHKCT) API returns, in bytes, the maximum
size configured for the communications trace tool and the portion of that size
that is currently in use for all communications traces active (running or
stopped state), or zero if no traces are active.</p>
<br>
<h3>Authorities and Locks</h3>
<p>Caller must have *SERVICE special authority, or be authorized to the Service
Trace function of i5/OS through iSeries Navigator's <a href=
"../rzaj3/rzaj3overview.htm">Application Administration</a> support.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Storage allocated</strong></dt>
<dd>OUTPUT; Binary(8)
<p>The variable containing the maximum bytes configured for the communications
trace tool after the QSCCHKCT API has completed processing.</p>
</dd>
<dt><strong>Storage in use</strong></dt>
<dd>Output; Binary(8)
<p>The variable containing the total bytes in use for all communications traces
active (running or stopped state), or zero if no traces are active, after the
QSCCHKCT API has completed processing.</p>
</dd>
<dt><strong>Error Code</strong></dt>
<dd>I/O; Char(*)
<p>The structure in which to return error information. For the format of the
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
</dd>
</dl>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top" nowrap>Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td align="left" valign="top">CPF222E E</td>
<td align="left" valign="top">&amp;1 special authority is
required.</td>
</tr>
<tr>
<td align="left" valign="top">CPF39A8 E</td>
<td align="left" valign="top">Not authorized to communications trace service
tool.</td>
</tr>
<tr>
<td align="left" valign="top">CPF39B6 E</td>
<td align="left" valign="top">Communications trace function cannot be
performed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF2 E</td>
<td align="left" valign="top">Error(s) occurred during running of &amp;1
API.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library
&amp;2 ended. Reason code &amp;3.</td>
</tr>
</table>
<br>
<hr>
API introduced: V5R2
<hr>
<center>
<table align="center" cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center">
<a href="#Top_Of_Page">Top</a> |
<a href="misc1.htm">Miscellaneous APIs</a> |
<a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</body>
</html>