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

278 lines
6.8 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>Query SQL Database Monitor (QQQQSDBM) 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/25/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>Query SQL Database Monitor (QQQQSDBM) 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%">Qualified job name</td>
<td align="left" valign="top" width="15%">Input</td>
<td align="left" valign="top" width="25%">Char(26)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Number of active monitors</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Size of active monitors array</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Type of active monitors array</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">Array(*) of Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Memory handle</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">6</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>
<br>
<p>The Query SQL Database Monitor (QQQSSDBM) API returns information about the
activity of the SQL and the original database monitor. Associated APIs include
the following:</p>
<ul>
<li>Clear SQL Database Monitor Statistics (QQQCSDBM)</li>
<li>Dump SQL Database Monitor (QQQDSDBM)</li>
<li>End SQL Database Monitor (QQQESDBM)</li>
<li>Start SQL Database Monitor (QQQSSDBM)</li>
</ul>
<br>
<h3>Authorities and Locks</h3>
<p>None</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Qualified job name</strong></dt>
<dd>INPUT; CHAR(26)
<p>The job for which status is being requested. The qualified job name has
three parts:</p>
<br>
<table width="100%">
<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:<br>
<br>
<br>
<table width="100%">
<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 valign="top"><em>*ALL</em></td>
<td valign="top">All jobs. The rest of the job name parameter must be
blank.</td>
</tr>
</table>
<br>
</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>
<br>
</dd>
<dt><strong>Number of active monitors</strong></dt>
<dd>OUTPUT; BINARY(4)
<p>The number of active database monitors. If the number of active monitors is
greater than the size of the type of active monitors array allocated by the
user, the type of active monitors array is truncated to the size allocated by
the user.</p>
</dd>
<dt><strong>Size of active monitors array</strong></dt>
<dd>INPUT; BINARY(4)
<p>The amount of storage (number of character(10) array entries) allocated by
the caller for the type of active monitors array parameter.</p>
</dd>
<dt><strong>Type of active monitors array</strong></dt>
<dd>OUTPUT; Array(*) of CHAR(10)
<p>The types of database monitors that are active. The values may include:</p>
<table width="100%">
<tr>
<td width="15%" valign="top"><em>*FILE</em></td>
<td width="85%" valign="top">The file-based database monitor (STRDBMON) is
active</td>
</tr>
<tr>
<td valign="top"><em>*SQLMEMORY</em></td>
<td valign="top">The SQL memory-based database monitor (QQQSSDBM) is
active.</td>
</tr>
<tr>
<td valign="top"></td>
<td valign="top"></td>
</tr>
</table>
<br>
</dd>
<dt><strong>Memory handle</strong></dt>
<dd>OUTPUT; CHAR(10)
<p>The memory handle used for the specified job if the memory-based monitor is
active. Only the first 6 characters will be used for naming the memory
handle.</p>
<p>This field is blank if the SQL memory-based database monitor is not
active.</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%">
<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">CPF0172 E</td>
<td width="85%" valign="top">Parameters passed on CALL do not match those
required.</td>
</tr>
<tr>
<td valign="top">CPF1321 E</td>
<td valign="top">job &amp;1 user &amp;2 job number &amp;3 not found.</td>
</tr>
<tr>
<td valign="top">CPF3CF1 E</td>
<td valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td valign="top">CPF436E E</td>
<td valign="top">Job &amp;1 user &amp;2 job number &amp;3 is not active.</td>
</tr>
</table>
<br>
<br>
<hr>
API introduced: V4R3
<hr>
<center>
<table cellpadding="2" cellspacing="2" width="600">
<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>