<?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 Server Instance Names (QzuiGetInstanceNames) 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_qzuigetinstancenames" /> <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 Server Instance Names (QzuiGetInstanceNames) API</title> </head> <body id="rzaieapi_qzuigetinstancenames"><a name="rzaieapi_qzuigetinstancenames"><!-- --></a> <!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script> <!--Java sync-link--><h1 class="topictitle1">Get Server Instance Names (QzuiGetInstanceNames) 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%">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%">2</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%">3</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%">4</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%">5</td> <td valign="top" width="31.313131313131315%">count</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%">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>QzuiGetInstanceNames</em> API to return a list of instance names, the type of instance and the running status of the instance.</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>buf</strong></dt> <dd>OUTPUT:CHAR(*) <p>Buffer to hold instance names and running data.</p> </dd> </dl> <dl><dt class="dlterm"><strong>buf_size</strong></dt> <dd>INPUT:BINARY(4) <p>Size of buffer passed.</p> </dd> </dl> <dl><dt class="dlterm"><strong>format</strong></dt> <dd>INPUT:CHAR(8) <p>Format of instance name data (INSN0110).</p> </dd> </dl> <dl><dt class="dlterm"><strong>buf_actlen</strong></dt> <dd>OUTPUT:BINARY(4) <p>Number of bytes of data placed in buf.</p> </dd> </dl> <dl><dt class="dlterm"><strong>count</strong></dt> <dd>OUTPUT:BINARY(4) <p>Total number of instance names.</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="insn0110_format"><a name="insn0110_format"><!-- --></a><h2 class="topictitle2">INSN0110 format</h2> <div><p>This data format is used by <em>QzuiGetInstanceNames</em> HTTP Server (powered by Apache) API.</p> <div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e178">Offset</th> <th valign="top" id="d0e180">Type</th> <th valign="top" id="d0e182">Field</th> </tr> </thead> <tbody><tr><td valign="top" headers="d0e178 ">0</td> <td valign="top" headers="d0e180 ">Char(10)</td> <td valign="top" headers="d0e182 ">Instance name</td> </tr> <tr><td valign="top" headers="d0e178 ">10</td> <td valign="top" headers="d0e180 ">Char(2)</td> <td valign="top" headers="d0e182 ">Reserved</td> </tr> <tr><td valign="top" headers="d0e178 ">14</td> <td valign="top" headers="d0e180 ">Binary(4)</td> <td valign="top" headers="d0e182 ">Running status</td> </tr> <tr><td valign="top" headers="d0e178 ">18</td> <td valign="top" headers="d0e180 ">Binary(4)</td> <td valign="top" headers="d0e182 ">Instance type 1 = HTTP Server (powered by Apache)</td> </tr> </tbody> </table> </div> </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 &1 not valid.</dd> </dl> <dl><dt class="dlterm"><strong>CPF3C21 E</strong></dt> <dd>Format name &1 not valid.</dd> </dl> <dl><dt class="dlterm"><strong>HTPA001 E</strong></dt> <dd>Input parameter &1 not valid.</dd> </dl> </div> </div> </body> </html>