friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
14ed2849c6
ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzaie_5.4.0.1/rzaieapi_qzhtrtvtcmpublishingrule.htm

385 lines
18 KiB
HTML
Raw Normal View History

Add readme and dist folders
2024-04-02 14:02:31 +00:00
<?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 Publishing Rule (QzhtRtvTCMPublishingRule) 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_qzhtrtvtcmpublishingrule" />
<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 Publishing Rule (QzhtRtvTCMPublishingRule)
API</title>
</head>
<body id="rzaieapi_qzhtrtvtcmpublishingrule"><a name="rzaieapi_qzhtrtvtcmpublishingrule"><!-- --></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 Publishing Rule (QzhtRtvTCMPublishingRule)
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 QzhtRtvTCMPublishingRule API retrieves information from publishing
rules associated with triggered cache manager servers. The API is a callable
service implemented as an ILE entry point within QZHTINCONF *SRVPGM in QTCM
*LIB. </p>
<p>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 publishing rule 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.</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>PRDG0100: Basic information format for a publishing rule.</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 the which publishing rule
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="prdg0100_format"><a name="prdg0100_format"><!-- --></a><h2 class="topictitle2">PRDG0100 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="d0e175">Offset</th>
<th rowspan="2" valign="top" id="d0e177">Type</th>
<th rowspan="2" valign="top" id="d0e179">Field</th>
</tr>
<tr><th valign="top" id="d0e182">Dec</th>
<th valign="top" id="d0e184">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e175 d0e182 ">0</td>
<td valign="top" headers="d0e175 d0e184 ">0</td>
<td valign="top" headers="d0e177 ">Binary(4)</td>
<td valign="top" headers="d0e179 ">Bytes returned</td>
</tr>
<tr><td valign="top" headers="d0e175 d0e182 ">4</td>
<td valign="top" headers="d0e175 d0e184 ">4</td>
<td valign="top" headers="d0e177 ">Binary(4)</td>
<td valign="top" headers="d0e179 ">Bytes available</td>
</tr>
<tr><td valign="top" headers="d0e175 d0e182 ">8</td>
<td valign="top" headers="d0e175 d0e184 ">8</td>
<td valign="top" headers="d0e177 ">Char(32)</td>
<td valign="top" headers="d0e179 ">Server name</td>
</tr>
<tr><td valign="top" headers="d0e175 d0e182 ">40</td>
<td valign="top" headers="d0e175 d0e184 ">28</td>
<td valign="top" headers="d0e177 ">Char(32)</td>
<td valign="top" headers="d0e179 ">Publishing rule name</td>
</tr>
<tr><td valign="top" headers="d0e175 d0e182 ">72</td>
<td valign="top" headers="d0e175 d0e184 ">48</td>
<td valign="top" headers="d0e177 ">Binary(4)</td>
<td valign="top" headers="d0e179 ">Offset to file extensions</td>
</tr>
<tr><td valign="top" headers="d0e175 d0e182 ">76</td>
<td valign="top" headers="d0e175 d0e184 ">4C</td>
<td valign="top" headers="d0e177 ">Binary(4)</td>
<td valign="top" headers="d0e179 ">Length of file extensions</td>
</tr>
<tr><td valign="top" headers="d0e175 d0e182 ">80</td>
<td valign="top" headers="d0e175 d0e184 ">50</td>
<td valign="top" headers="d0e177 ">Binary(4)</td>
<td valign="top" headers="d0e179 ">Read from data source</td>
</tr>
<tr><td valign="top" headers="d0e175 d0e182 ">84</td>
<td valign="top" headers="d0e175 d0e184 ">54</td>
<td valign="top" headers="d0e177 ">Binary(4)</td>
<td valign="top" headers="d0e179 ">Send data source version</td>
</tr>
<tr><td valign="top" headers="d0e175 d0e182 ">88</td>
<td valign="top" headers="d0e175 d0e184 ">58</td>
<td valign="top" headers="d0e177 ">Binary(4)</td>
<td valign="top" headers="d0e179 ">Parse and assemble</td>
</tr>
<tr><td valign="top" headers="d0e175 d0e182 ">92</td>
<td valign="top" headers="d0e175 d0e184 ">5C</td>
<td valign="top" headers="d0e177 ">Binary(4)</td>
<td valign="top" headers="d0e179 ">Send assembled version</td>
</tr>
<tr><td valign="top" headers="d0e175 d0e182 ">96</td>
<td valign="top" headers="d0e175 d0e184 ">60</td>
<td valign="top" headers="d0e177 ">Binary(4)</td>
<td valign="top" headers="d0e179 ">Offset to new file extension</td>
</tr>
<tr><td valign="top" headers="d0e175 d0e182 ">100</td>
<td valign="top" headers="d0e175 d0e184 ">64</td>
<td valign="top" headers="d0e177 ">Binary(4)</td>
<td valign="top" headers="d0e179 ">Length of new file extension</td>
</tr>
<tr><td valign="top" headers="d0e175 d0e182 ">&nbsp;</td>
<td valign="top" headers="d0e175 d0e184 ">&nbsp;</td>
<td valign="top" headers="d0e177 ">Char(*)</td>
<td valign="top" headers="d0e179 ">File extensions</td>
</tr>
<tr><td valign="top" headers="d0e175 d0e182 ">&nbsp;</td>
<td valign="top" headers="d0e175 d0e184 ">&nbsp;</td>
<td valign="top" headers="d0e177 ">Char(*)</td>
<td valign="top" headers="d0e179 ">New file extensions</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="prdg0100_field_descriptions"><a name="prdg0100_field_descriptions"><!-- --></a><h2 class="topictitle2">PRDG0100 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>The number of bytes of information returned to the caller of the API.</dd>
</dl>
<dl><dt class="dlterm"><strong>File extensions</strong></dt>
<dd>A list of file extensions used to identify files that are processed according
to the publishing rule. File extensions are listed as a string of characters,
where each extension is separated by one space (left justified and padded
with blanks if necessary). <div class="note"><span class="notetitle">Note:</span> File names are compared to file extensions
starting at the last period in the file name.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Length of file extensions</strong></dt>
<dd>The length of the information returned for the File extensions entry.</dd>
</dl>
<dl><dt class="dlterm"><strong>Length of new file extension</strong></dt>
<dd>The length of the information returned for the New file extension entry.</dd>
</dl>
<dl><dt class="dlterm"><strong>New file extension</strong></dt>
<dd>The string of characters used as a new extension to rename files after
they have been assembled and before they are sent to the cache targets (left
justified and padded with blanks if necessary).<div class="note"><span class="notetitle">Note:</span> If the value is null,
Offset to new file extension equals 0 (QZHT_NONE), indicating that the triggered
cache manager server does not rename files prior to sending them to the cache
targets.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Offset to new file extension</strong></dt>
<dd>The offset from the beginning of the receiver variable to the New file
extension 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="16.161616161616163%"><strong>0</strong></td>
<td valign="top" width="83.83838383838383%">QZHT_NONE: The value is null for New file extensions.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Offset to file extensions</strong></dt>
<dd>The offset from the beginning of the request variable to the File extensions
data, in bytes.</dd>
</dl>
<dl><dt class="dlterm"><strong>Parse and assemble</strong></dt>
<dd>Indicates if files matching this publishing rule are parsed for wrappers
and includes, and possibly sent through the page assembler. 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="16.161616161616163%"><strong>1</strong></td>
<td valign="top" width="83.83838383838383%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: Files matching this
publishing rule are parsed and possibly sent through the page assembler.</td>
</tr>
<tr><td valign="top" width="16.161616161616163%"><strong>0</strong></td>
<td valign="top" width="83.83838383838383%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: Files matching this
publishing rule are not parsed.<div class="note"><span class="notetitle">Note:</span> Files that are not parsed are not sent
through the page assembler.</div>
</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Publishing rule name</strong></dt>
<dd>The name of the publishing rule, left justified and padded with blanks
if necessary.</dd>
</dl>
<dl><dt class="dlterm"><strong>Read from data source</strong></dt>
<dd>Indicates if files matching this publishing rule are read from the data
source when triggered. The value returned is 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="16.161616161616163%"><strong>1</strong></td>
<td valign="top" width="83.83838383838383%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: Files matching this
publishing rule are read from the data source when triggered.</td>
</tr>
<tr><td valign="top" width="16.161616161616163%"><strong>0</strong></td>
<td valign="top" width="83.83838383838383%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: Files matching this
publishing rule are not read from the data source.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Send assembled version</strong></dt>
<dd>Indicates if the assembled version of files matching this publishing rule
are sent to cache targets when triggered and processed. 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="16.161616161616163%"><strong>1</strong></td>
<td valign="top" width="83.83838383838383%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: Assembled versions
of files matching this publishing rule are sent to cache targets when triggered
and processed.</td>
</tr>
<tr><td valign="top" width="16.161616161616163%"><strong>0</strong></td>
<td valign="top" width="83.83838383838383%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: Assembled versions
of files matching this publishing rule are not sent to cache targets.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Send data source version</strong></dt>
<dd>Indicates if the data source version of files matching this publishing
rule (the version read from the data source prior to assembly) are sent to
cache targets when triggered and processed. The value returned is 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="16.161616161616163%"><strong>1</strong></td>
<td valign="top" width="83.83838383838383%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: Data source versions
of files matching this publishing rule are sent to cache targets when triggered
and processed.</td>
</tr>
<tr><td valign="top" width="16.161616161616163%"><strong>0</strong></td>
<td valign="top" width="83.83838383838383%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: Data source versions
of files matching this publishing rule are not sent to cache targets.</td>
</tr>
</tbody>
</table>
</div>
</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 &amp;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">TCM703E E</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 &amp;1.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7190 E</strong></dt>
<dd>A configuration file for triggered cache manager server &amp;1 was not
found.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7290 E</strong></dt>
<dd>&amp;1&amp;2 was not found for triggered cache manager server &amp;3.</dd>
</dl>
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink