<!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>Cycle Collector (QYPSCYCC, QypsCycleCollector) 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. --> <!-- GSA ADP Schedule Contract with IBM Corp. --> <!-- Change History: --> <!-- YYMMDD USERID Change description --> <!--File edited Oct 2001 by v2cdijab --> <!-- 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 language="Javascript" src="../rzahg/synch.js" type="text/javascript"> </script> <h2>Cycle Collector (QYPSCYCC, QypsCycleCollector) API</h2> <div class="box" style="width: 60%;"> <br> 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%">Collector name</td> <td align="left" valign="top" width="20%">Input</td> <td align="left" valign="top" width="20%">Char(10)</td> </tr> <tr> <td align="center" valign="top">2</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> Default Public Authority: *USE<br> <!-- iddvc RMBR --> <br> Service program: QYPSCOLL<br> <!-- iddvc RMBR --> <br> Threadsafe: No<br> <!-- iddvc RMBR --> <br> </div> <p>The Cycle Collector (QYPSCYCC, QypsCycleCollector) API closes current collection objects and begins writing collection data to new collection objects.</p> <br> <h3>Authorities and Locks</h3> <dl> <dt><em>API Public Authority</em></dt> <dd>*EXCLUDE</dd> <dt><em>Job Authority</em></dt> <dd>*JOBCTL</dd> </dl> <br> <h3>Required Parameter Group</h3> <dl> <dt><strong>Collector name</strong></dt> <dd>INPUT; CHAR(10) <p>The name of the collector to be cycled. The special value is:</p> <table cellpadding="5"> <!-- cols="10 90" --> <tr> <td align="left" valign="top"><em>*PFR</em></td> <td align="left" valign="top">Performance collector</td> </tr> </table> <br> </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">Message ID</th> <th align="left" valign="top">Error Message Text</th> </tr> <tr> <td align="left" valign="top" width="15%">CPF222E E</td> <td align="left" valign="top" width="85%">&1 special authority is required.</td> </tr> <tr> <td align="left" valign="top">CPF3C1E E</td> <td align="left" valign="top">Required parameter &1 omitted.</td> </tr> <tr> <td align="left" valign="top">CPF3C3C E</td> <td align="left" valign="top">Value for parameter &1 is not valid.</td> </tr> <tr> <td align="left" valign="top">CPF3C36 E</td> <td align="left" valign="top">Number of parameters, &1, entered for this API was not valid.</td> </tr> <tr> <td align="left" valign="top">CPF3CF2 E</td> <td align="left" valign="top">Errors occurred during running of &1 API.</td> </tr> <tr> <td align="left" valign="top">CPFB94A E</td> <td align="left" valign="top">Collector communications error. Reason code &1.</td> </tr> </table> <br> <hr> API introduced: V4R4 <hr> <center> <table cellpadding="2" cellspacing="2"> <tr align="center"> <td valign="middle" align="center"><a href="qypscsca.htm">Top</a> | <a href= "perfmgmt.htm">Performance Management APIs</a> | <a href="aplist.htm">APIs by category</a></td> </tr> </table> </center> </body> </html>