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_qzhtrtvtcmbasicconfig.htm

294 lines
14 KiB
HTML
Raw Blame History

<?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 Basic Configuration (QzhtRtvTCMBasicConfig) 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_qzhtrtvtcmbasicconfig" />
<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 Basic Configuration (QzhtRtvTCMBasicConfig)
API</title>
</head>
<body id="rzaieapi_qzhtrtvtcmbasicconfig"><a name="rzaieapi_qzhtrtvtcmbasicconfig"><!-- --></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 Basic Configuration (QzhtRtvTCMBasicConfig)
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%">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>Use the QzhtRtvTCMBasicConfig API to retrieve the basic configuration information
for a triggered cache manager server. The API is a callable service implemented
as an ILE entry point within the QZHTINCONF *SRVPGM in the 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>OUTPUT: CHAR(*) <p>The variable used to return the basic configuration
information for the triggered cache manager server.</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 receiver variable data. The following
values must be used:</p>
<ul><li>INDG0200: Detailed information format for server data.</li>
</ul>
</dd>
</dl>
<dl><dt class="dlterm"><strong>server name</strong></dt>
<dd>INPUT: CHAR(32) <p>The name used to identify the triggered cache manager
server from which the configuration 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="indg0200_format"><a name="indg0200_format"><!-- --></a><h2 class="topictitle2">INDG0200 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="d0e157">Offset</th>
<th rowspan="2" valign="top" id="d0e159">Type</th>
<th rowspan="2" valign="top" id="d0e161">Field</th>
</tr>
<tr><th valign="top" id="d0e164">Dec</th>
<th valign="top" id="d0e166">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e157 d0e164 ">0</td>
<td valign="top" headers="d0e157 d0e166 ">0</td>
<td valign="top" headers="d0e159 ">Binary(4)</td>
<td valign="top" headers="d0e161 ">Bytes returned</td>
</tr>
<tr><td valign="top" headers="d0e157 d0e164 ">4</td>
<td valign="top" headers="d0e157 d0e166 ">4</td>
<td valign="top" headers="d0e159 ">Binary(4)</td>
<td valign="top" headers="d0e161 ">Bytes available</td>
</tr>
<tr><td valign="top" headers="d0e157 d0e164 ">8</td>
<td valign="top" headers="d0e157 d0e166 ">8</td>
<td valign="top" headers="d0e159 ">Char(32)</td>
<td valign="top" headers="d0e161 ">Server name</td>
</tr>
<tr><td valign="top" headers="d0e157 d0e164 ">40</td>
<td valign="top" headers="d0e157 d0e166 ">28</td>
<td valign="top" headers="d0e159 ">Binary(4)</td>
<td valign="top" headers="d0e161 ">Autostart property</td>
</tr>
<tr><td valign="top" headers="d0e157 d0e164 ">44</td>
<td valign="top" headers="d0e157 d0e166 ">2C</td>
<td valign="top" headers="d0e159 ">Binary(4)</td>
<td valign="top" headers="d0e161 ">Local TCP port</td>
</tr>
<tr><td valign="top" headers="d0e157 d0e164 ">48</td>
<td valign="top" headers="d0e157 d0e166 ">30</td>
<td valign="top" headers="d0e159 ">Binary(4)</td>
<td valign="top" headers="d0e161 ">Offset to root directory</td>
</tr>
<tr><td valign="top" headers="d0e157 d0e164 ">52</td>
<td valign="top" headers="d0e157 d0e166 ">34</td>
<td valign="top" headers="d0e159 ">Binary(4)</td>
<td valign="top" headers="d0e161 ">Length of root directory</td>
</tr>
<tr><td valign="top" headers="d0e157 d0e164 ">56</td>
<td valign="top" headers="d0e157 d0e166 ">38</td>
<td valign="top" headers="d0e159 ">Binary(4)</td>
<td valign="top" headers="d0e161 ">Maximum number of entries</td>
</tr>
<tr><td valign="top" headers="d0e157 d0e164 ">60</td>
<td valign="top" headers="d0e157 d0e166 ">3C</td>
<td valign="top" headers="d0e159 ">Binary(4)</td>
<td valign="top" headers="d0e161 ">Defer time between retries</td>
</tr>
<tr><td valign="top" headers="d0e157 d0e164 ">64</td>
<td valign="top" headers="d0e157 d0e166 ">40</td>
<td valign="top" headers="d0e159 ">Binary(4)</td>
<td valign="top" headers="d0e161 ">Memory buffer size</td>
</tr>
<tr><td valign="top" headers="d0e157 d0e164 ">&nbsp;</td>
<td valign="top" headers="d0e157 d0e166 ">&nbsp;</td>
<td valign="top" headers="d0e159 ">Binary(4)</td>
<td valign="top" headers="d0e161 ">Root directory</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="field_descriptions"><a name="field_descriptions"><!-- --></a><h2 class="topictitle2">Field descriptions</h2>
<div><dl><dt class="dlterm"><strong>Autostart property</strong></dt>
<dd>Specifies if the new triggered cache manager server is to start when startup
of *AUTOSTART triggered cache manager servers, is requested. Usually *AUTOSTART
servers are requested to start when TCP/IP is started, however they may also
be requested via the STRTCPSVR command or QzhtStrTCMServer API. The default
value is 0 (QZHT_NO). <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.544041450777202%"><strong>1</strong></td>
<td valign="top" width="84.4559585492228%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The server is set
to start when startup of *AUTOSTART servers is requested.</td>
</tr>
<tr><td valign="top" width="15.544041450777202%"><strong>2</strong></td>
<td valign="top" width="84.4559585492228%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The server is not
set to start when startup of *AUTOSTART servers is requested.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<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 information bytes returned to the caller of the API.</dd>
</dl>
<dl><dt class="dlterm"><strong>Defer time between retries</strong></dt>
<dd>The number of seconds the triggered cache manager server waits between
retry attempts for a failing action. The value returned is greater than 0
and less than 2<sup>31</sup> (or 2.147x10<sup>9</sup>), or equal to the following
special value: <strong>0</strong> QZHT_NONE: No defer time is used.</dd>
</dl>
<dl><dt class="dlterm"><strong>Length of root directory</strong></dt>
<dd>The length of the information for the root directory entry.</dd>
</dl>
<dl><dt class="dlterm"><strong>Local TCP port</strong></dt>
<dd>The number of one of the TCP ports used by the triggered cache manager
server. The return value is greater than 0 and less than 65536.</dd>
</dl>
<dl><dt class="dlterm"><strong>Maximum number of entries</strong></dt>
<dd>The maximum number of time the triggered cache manager server attempts
to retry a failing action. The return value is greater than -1 and less than
2<sup>31</sup> (or 2.147x10<sup>9</sup>), 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.544041450777202%"><strong>0</strong></td>
<td valign="top" width="84.4559585492228%">QZHT_NONE: Failing actions are not retried.</td>
</tr>
<tr><td valign="top" width="15.544041450777202%"><strong>-3</strong></td>
<td valign="top" width="84.4559585492228%">QZHT_NOMAX: Retry failing actions until successful.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Memory buffer size</strong></dt>
<dd>The maximum amount of working data the triggered cache manager server
attempts to store in memory, in bytes. The return value is greater than -1
and less than 2<sup>31</sup> (or 2.147x10<sup>9</sup>) bytes.</dd>
</dl>
<dl><dt class="dlterm"><strong>Offset to root directory</strong></dt>
<dd>The offset from the beginning of the request variable to the root directory
data, in bytes.</dd>
</dl>
<dl><dt class="dlterm"><strong>Root directory</strong></dt>
<dd>The name of the local file system directory in which the triggered cache
manager server maintains its persistent record of incoming transactions, 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 for which the configuration
information is retrieved (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>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 &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>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink