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

150 lines
7.2 KiB
HTML
Raw Permalink 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="Get Apache Server Instance Data (QzuiGetInstanceData) 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_qzuigetinstancedata" />
<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>Get Apache Server Instance Data (QzuiGetInstanceData) API</title>
</head>
<body id="rzaieapi_qzuigetinstancedata"><a name="rzaieapi_qzuigetinstancedata"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<!--Java sync-link--><h1 class="topictitle1">Get Apache Server Instance Data (QzuiGetInstanceData) 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="note"><span class="notetitle">Note:</span> This API is for HTTP Server (powered by Apache)</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%">name</td>
<td valign="top" width="31.060606060606062%">Input</td>
<td valign="top" width="31.313131313131315%">Char(10)</td>
</tr>
<tr><td align="right" valign="top" width="6.313131313131313%">2</td>
<td valign="top" width="31.313131313131315%">buf</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%">3</td>
<td valign="top" width="31.313131313131315%">buf_size</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%">4</td>
<td valign="top" width="31.313131313131315%">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%">5</td>
<td valign="top" width="31.313131313131315%">buf_actlen</td>
<td valign="top" width="31.060606060606062%">Output</td>
<td valign="top" width="31.313131313131315%">Binary(4)</td>
</tr>
<tr><td align="right" valign="top" width="6.313131313131313%">6</td>
<td valign="top" width="31.313131313131315%">running</td>
<td valign="top" width="31.060606060606062%">Output</td>
<td valign="top" width="31.313131313131315%">Binary(4)</td>
</tr>
<tr><td align="right" valign="top" width="6.313131313131313%">7</td>
<td valign="top" width="31.313131313131315%">errcode</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">Threadsafe: Yes</td>
</tr>
</tbody>
</table>
</div>
<p>Use the <em>QzuiGetInstanceData</em> API to retrieve the data from a specified
server instance file. The data information is returned in the format specified
by INSD0110. See <a href="rzaieapi_qzuichangeinstancedata.htm#insd0110_format">INSD0110 format</a> for more information.</p>
</div>
<div class="nested1" id="authoritylocks"><a name="authoritylocks"><!-- --></a><h2 class="topictitle2">Authorities and locks</h2>
<div><ul><li>*EXECUTE authority to the QUSRSYS library</li>
<li>*OBJOPR and *READ authority to the QUSRSYS/QATMHINSTC file</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>name</strong></dt>
<dd>INPUT:CHAR(10) <p>Name of the server instance from which data is retrieved.</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>buf</strong></dt>
<dd>OUTPUT:CHAR(*) <p>Buffer in format INSD0110 containing instance file data.</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>buf_size</strong></dt>
<dd>INPUT:BINARY(4) <p>Length of instance data buffer.</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>format</strong></dt>
<dd>INPUT:CHAR(8) <p>Format of the instance data (INSD0110).</p>
<p>See <a href="rzaieapi_qzuichangeinstancedata.htm#insd0110_format">INSD0110 format</a> for
more information.</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>buf_actlen</strong></dt>
<dd>OUTPUT:BINARY(4) <p>Actual length of instance data returned.</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>running</strong></dt>
<dd>OUTPUT:BINARY(4) <p>Indicates if the instance is currently running (1
= running).</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>errcode</strong></dt>
<dd>I/O:CHAR(*) <p>Error information structure.</p>
</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>CPF3C17 E</strong></dt>
<dd>Error occurred with input data parameter.</dd>
</dl>
<dl><dt class="dlterm"><strong>CPF3C19 E</strong></dt>
<dd>Error occurred with receiver variable specified.</dd>
</dl>
<dl><dt class="dlterm"><strong>CPF3C1D E</strong></dt>
<dd>Input variable length in parameter &amp;1 not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>CPF3C21 E</strong></dt>
<dd>Format name &amp;1 not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>CPF3CF1 E</strong></dt>
<dd>Error code parameter not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>HTPA001 E</strong></dt>
<dd>Input parameter &amp;1 not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>HTPA101 E</strong></dt>
<dd>Server instance &amp;1 not found or is unreadable.</dd>
</dl>
<dl><dt class="dlterm"><strong>HTPA127 E</strong></dt>
<dd>Server instance &amp;1 is not a HTTP Server (powered by Apache) type instance.</dd>
</dl>
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink