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

257 lines
6.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>Clear SQL Database Monitor Statistics (QQQCSDBM) 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. -->
<!-- File SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!--File Edited March 2001 -->
<!-- This file has undergone html cleanup on 9/20/01 by JET -->
<!--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>Clear SQL Database Monitor Statistics (QQQCSDBM) 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%">Memory handle to clear</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">Job or memory handle name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(26)</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: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Clear SQL Database Monitor Statistics (QQQCSDBM) API clears and frees
the associated memory area of the database monitor statistics. Associated APIs
include the following:</p>
<ul>
<li>Dump SQL Database Monitor (QQQDSDBM)</li>
<li>End SQL Database Monitor (QQQESDBM)</li>
<li>Query SQL Database Monitor (QQQQSDBM)</li>
<li>Start SQL Database Monitor (QQQSSDBM)</li>
</ul>
<br>
<h3>Authorities and Locks</h3>
<dl compact>
<dt><em>Current User Profile</em></dt>
<dd>*JOBCTL</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Memory area to clear</strong></dt>
<dd>INPUT; CHAR(10)
<p>The memory area to be cleared or freed. The possible values are:</p>
<table>
<tr>
<td width="15%" valign="top"><em>*ALL</em></td>
<td width="85%" valign="top">Clear the monitor data associated with the *ALL
monitor (the monitor started against ALL jobs). Memory areas associated with
QQQSSDBM started on individual jobs will not be cleared. No storage is
freed.</td>
</tr>
<tr>
<td valign="top"><em>*NAMED</em></td>
<td valign="top">Clear the memory handle specified by the job or memory handle
name parameter (and matches the name of a memory handle specified on the
QQQSSDBM API). No storage is freed. Only the first 6 characters will be used
for naming the memory handle.</td>
</tr>
<tr>
<td valign="top"><em>*JOB</em></td>
<td valign="top">Clear the job specific data associated with the job name
specified in the job or memory handle name parameter. No storage is freed.</td>
</tr>
<tr>
<td valign="top"><em>*RESET</em></td>
<td valign="top">Clear and free all memory associated with all active or
inactive database monitors. The *RESET option cannot be specified on a specific
job or memory handle.</td>
</tr>
</table>
</dd>
<dt><strong>Job or memory handle name</strong></dt>
<dd>INPUT; CHAR(26)
<p>This parameter depends on the value specified for the memory area to clear
parameter. If the value is:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td valign="top"><em>*ALL</em></td>
<td valign="top">This parameter must be set to blanks.</td>
</tr>
<tr>
<td valign="top"><em>*RESET</em></td>
<td valign="top">This parameter must be set to blanks.</td>
</tr>
<tr>
<td valign="top"><em>*NAMED</em></td>
<td valign="top">The CHAR(10) name of a memory handle whose data is to be
cleared. Only the first 6 characters will be used for naming the memory handle,
with the remaining characters set to blanks.</td>
</tr>
<tr>
<td valign="top"><em>*JOB</em></td>
<td valign="top">The CHAR(26) qualified job name of a job-specific monitor to
dump.<br>
The qualified job name has three parts:<br>
<table>
<tr>
<td width="15%" valign="top"><em>Job Name</em></td>
<td width="85%" valign="top">CHAR(10). A specific job name, a generic name, or
one of the following special values:
<table>
<tr>
<td width="15%" valign="top"><em>* or *CURRENT</em></td>
<td width="85%" valign="top">Only the job that this program is running in. The
rest of the qualified job name parameter must be blank.</td>
</tr>
<tr>
<td width="25%" valign="top"><em>*ALL</em></td>
<td width="75%" valign="top">All jobs. The rest of the job name parameter must
be blank.</td>
</tr>
</table>
</td>
</tr>
<tr>
<td valign="top"><em>User Name</em></td>
<td valign="top">CHAR(10). A specific user profile name.</td>
</tr>
<tr>
<td valign="top"><em>Job Number</em></td>
<td valign="top">CHAR(6). A specific job number.</td>
</tr>
</table>
</td>
</tr>
</table>
</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%">
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td width="15%" valign="top">CPD0172 D</td>
<td width="85%" valign="top">Error Parameters passed on CALL do ot match those
required.</td>
</tr>
<tr>
<td valign="top">CPF222E E</td>
<td valign="top">&amp;1 special authority required.</td>
</tr>
<tr>
<td valign="top">CPF3CF1 E</td>
<td valign="top">Error code parameter not valid.</td>
</tr>
</table>
<br>
<hr>
API introduced: V4R3
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"file1.htm">Database and File APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</center>
<br>
</body>
</html>