277 lines
13 KiB
HTML
277 lines
13 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="topic" />
|
||
|
|
<meta name="DC.Title" content="Retrieve Triggered Cache Manager Rule Set (QzhtRtvTCMRuleSet) API" />
|
||
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 2002,2006" />
|
||
|
|
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 2002,2006" />
|
||
|
|
<meta name="DC.Format" content="XHTML" />
|
||
|
|
<meta name="DC.Identifier" content="rzaieapi_qzhtrtvtcmruleset" />
|
||
|
|
<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>Retrieve Triggered Cache Manager Rule Set (QzhtRtvTCMRuleSet) API</title>
|
||
|
|
</head>
|
||
|
|
<body id="rzaieapi_qzhtrtvtcmruleset"><a name="rzaieapi_qzhtrtvtcmruleset"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<!--Java sync-link--><h1 class="topictitle1">Retrieve Triggered Cache Manager Rule Set (QzhtRtvTCMRuleSet) API</h1>
|
||
|
|
<div><div class="important"><span class="importanttitle">Important:</span> Information
|
||
|
|
for this topic supports the latest PTF levels for HTTP Server for i5/OS .
|
||
|
|
It is recommended that you install the latest PTFs to upgrade to the latest
|
||
|
|
level of the HTTP Server for i5/OS. Some of the topics documented here are
|
||
|
|
not available prior to this update. See <a href="http://www-03.ibm.com/servers/eserver/iseries/software/http/services/service.html" target="_blank">http://www.ibm.com/servers/eserver/iseries/software/http/services/service.htm</a> <img src="www.gif" alt="Link outside Information Center" /> for more information. </div>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" class="figborder" frame="void" border="0" rules="none"><tbody><tr><td colspan="4" valign="top">Required Parameter Group:</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">1</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">receiver variable</td>
|
||
|
|
<td valign="top" width="31.060606060606062%">Output</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">2</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">length of receiver variable</td>
|
||
|
|
<td valign="top" width="31.060606060606062%">Input</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">3</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">receiver variable format</td>
|
||
|
|
<td valign="top" width="31.060606060606062%">Input</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Char(8)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">4</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">server name</td>
|
||
|
|
<td valign="top" width="31.060606060606062%">Input</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Char(32)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">5</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">description name</td>
|
||
|
|
<td valign="top" width="31.060606060606062%">Input</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Char(32)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">6</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">error code</td>
|
||
|
|
<td valign="top" width="31.060606060606062%">I/O</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="4" valign="top">Library Name/Service Program: QTCM/QZHTINCONF</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="4" valign="top">Threadsafe: Yes</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<p>The QzhtRtvTCMRuleSet API retrieves information from rule sets associated
|
||
|
|
with triggered cache manager servers. The API is a callable service implemented
|
||
|
|
as an ILE entry point within the QZHTINCONF *SRVPGM in the QTCM *LIB. The
|
||
|
|
QTCM/H(QZHTINCONF) header file includes ILE C prototypes for this API.</p>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="authoritylocks"><a name="authoritylocks"><!-- --></a><h2 class="topictitle2">Authorities and locks</h2>
|
||
|
|
<div><ul><li>*IOSYSCFG special authority</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="required"><a name="required"><!-- --></a><h2 class="topictitle2">Required parameter group</h2>
|
||
|
|
<div><dl><dt class="dlterm"><strong>receiver variable</strong></dt>
|
||
|
|
<dd>INPUT: CHAR(*) <p>The variable used to return rule set information.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>length of receiver variable</strong></dt>
|
||
|
|
<dd>INPUT: BINARY(4) <p>The number of bytes that the calling program provides
|
||
|
|
for receiver variable. This value must be greater than or equal to 8.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>receiver variable format</strong></dt>
|
||
|
|
<dd>INPUT: CHAR(8) <p>The format name of the receiver variable data. The following
|
||
|
|
values must be used:</p>
|
||
|
|
<ul><li>RSDG0100: Basic information format for a rule set.</li>
|
||
|
|
</ul>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>server name</strong></dt>
|
||
|
|
<dd>INPUT: CHAR(32) <p>The name used to identify the server for which information
|
||
|
|
is retrieved (left justified and padded with blanks if necessary).</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>description name</strong></dt>
|
||
|
|
<dd>INPUT: CHAR(32)<p> The name used to identify which rule set information
|
||
|
|
is retrieved (left justified and padded with blanks if necessary).</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>error code</strong></dt>
|
||
|
|
<dd>I/O: CHAR(*) <p>The structure in which to return error information.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="rsdg0100_format"><a name="rsdg0100_format"><!-- --></a><h2 class="topictitle2">RSDG0100 format</h2>
|
||
|
|
<div>
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th colspan="2" valign="top" id="d0e173">Offset</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e175">Type</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e177">Field</th>
|
||
|
|
</tr>
|
||
|
|
<tr><th valign="top" id="d0e180">Dec</th>
|
||
|
|
<th valign="top" id="d0e182">Hex</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e173 d0e180 ">0</td>
|
||
|
|
<td valign="top" headers="d0e173 d0e182 ">0</td>
|
||
|
|
<td valign="top" headers="d0e175 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e177 ">Bytes returned</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e173 d0e180 ">4</td>
|
||
|
|
<td valign="top" headers="d0e173 d0e182 ">4</td>
|
||
|
|
<td valign="top" headers="d0e175 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e177 ">Bytes available</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e173 d0e180 ">8</td>
|
||
|
|
<td valign="top" headers="d0e173 d0e182 ">8</td>
|
||
|
|
<td valign="top" headers="d0e175 ">Char(32)</td>
|
||
|
|
<td valign="top" headers="d0e177 ">Server name</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e173 d0e180 ">40</td>
|
||
|
|
<td valign="top" headers="d0e173 d0e182 ">28</td>
|
||
|
|
<td valign="top" headers="d0e175 ">Char(32)</td>
|
||
|
|
<td valign="top" headers="d0e177 ">Rule set name</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e173 d0e180 ">72</td>
|
||
|
|
<td valign="top" headers="d0e173 d0e182 ">48</td>
|
||
|
|
<td valign="top" headers="d0e175 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e177 ">Default property</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e173 d0e180 ">76</td>
|
||
|
|
<td valign="top" headers="d0e173 d0e182 ">52</td>
|
||
|
|
<td valign="top" headers="d0e175 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e177 ">Offset to publishing rules</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e173 d0e180 ">80</td>
|
||
|
|
<td valign="top" headers="d0e173 d0e182 ">56</td>
|
||
|
|
<td valign="top" headers="d0e175 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e177 ">Length of publishing rules</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e173 d0e180 "> </td>
|
||
|
|
<td valign="top" headers="d0e173 d0e182 "> </td>
|
||
|
|
<td valign="top" headers="d0e175 ">Char(*)</td>
|
||
|
|
<td valign="top" headers="d0e177 ">Publishing rules</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="rsdg0100_field_descriptions"><a name="rsdg0100_field_descriptions"><!-- --></a><h2 class="topictitle2">RSDG0100 format field descriptions</h2>
|
||
|
|
<div><dl><dt class="dlterm"><strong>Bytes available</strong></dt>
|
||
|
|
<dd>The number of information bytes available for return to the caller of
|
||
|
|
the API.<div class="note"><span class="notetitle">Note:</span> If this value is greater than the value of Bytes returned, the
|
||
|
|
receiver variable was not large enough to return all information.</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>Bytes returned</strong></dt>
|
||
|
|
<dd>BINARY(4) <p>The number of bytes of information returned to the caller
|
||
|
|
of the API.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>Default property</strong></dt>
|
||
|
|
<dd>Indicates whether the description is the current default rule set for
|
||
|
|
the triggered cache manager server specified in Server name. The returned
|
||
|
|
value equals one of the special values described below. <p>Special values
|
||
|
|
and their meanings are as follows:</p>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.816326530612246%"><strong>1</strong></td>
|
||
|
|
<td valign="top" width="84.18367346938776%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The description is
|
||
|
|
the current default for this server.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.816326530612246%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.18367346938776%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The description
|
||
|
|
is not the current default.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>Length of publishing rules</strong></dt>
|
||
|
|
<dd>The length of the information returned for the Publishing rules entry.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>Offset to publishing rules</strong></dt>
|
||
|
|
<dd>The offset from the beginning of the receiver variable to the Publishing
|
||
|
|
rules data, in bytes. The value returned is greater than 0, or equal to one
|
||
|
|
of the special values described below.<p>Special values and their meanings
|
||
|
|
are as follows:</p>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.816326530612246%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.18367346938776%">QZHT_NONE: The value is null for Publishing rules.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>Publishing rules</strong></dt>
|
||
|
|
<dd>The list of publishing rules currently referenced are listed by name,
|
||
|
|
separated by one (left justified and padded with blanks if necessary).<div class="note"><span class="notetitle">Note:</span> If
|
||
|
|
the value is null, Offset to publishing rules equals 0 (QZHT_NONE), indicating
|
||
|
|
that an empty rule set is described. An empty rule set referenced by a trigger
|
||
|
|
handler causes it to process all triggers according to the default publishing
|
||
|
|
rule.</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>Rule set object name</strong></dt>
|
||
|
|
<dd>The name of the rule set (left justified and padded with blanks if necessary).</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>Server name</strong></dt>
|
||
|
|
<dd>The name of the triggered cache manager server with which the description
|
||
|
|
is associated (left justified and padded with blanks if necessary).</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="error"><a name="error"><!-- --></a><h2 class="topictitle2">Error messages</h2>
|
||
|
|
<div><dl><dt class="dlterm"><strong>TCM7001 E</strong></dt>
|
||
|
|
<dd>User &1 is not authorized.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM7030 E</strong></dt>
|
||
|
|
<dd>Severe error occurred while addressing parameter list.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM7032 E</strong></dt>
|
||
|
|
<dd>Receiver variable format is not valid.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM7034 E</strong></dt>
|
||
|
|
<dd>Length of receiver variable is not valid for the specified format.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM7035 E</strong></dt>
|
||
|
|
<dd>Server parameter is not valid.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM7036 E</strong></dt>
|
||
|
|
<dd>Description parameter is not valid.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM703E E</strong></dt>
|
||
|
|
<dd>Error code parameter is not valid</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM70F0 E</strong></dt>
|
||
|
|
<dd>Unknown error occurred while processing request.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM7101 E</strong></dt>
|
||
|
|
<dd>User QTCM is not authorized to the configuration file for triggered cache
|
||
|
|
manager server &1.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM7190 E</strong></dt>
|
||
|
|
<dd>A configuration file for triggered cache manager server &1 was not
|
||
|
|
found.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM7290 E</strong></dt>
|
||
|
|
<dd>&1&2 was not found for triggered cache manager server &3.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|