221 lines
10 KiB
HTML
221 lines
10 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="Find Config Object (QzuiFindConfigObject) 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_qzuifindconfigobject" />
|
||
|
|
<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>Find Config Object (QzuiFindConfigObject) API</title>
|
||
|
|
</head>
|
||
|
|
<body id="rzaieapi_qzuifindconfigobject"><a name="rzaieapi_qzuifindconfigobject"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<!--Java sync-link--><h1 class="topictitle1">Find Config Object (QzuiFindConfigObject) 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%">cfg</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%">2</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">fdata</td>
|
||
|
|
<td valign="top" width="31.060606060606062%">Input</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%">fdata_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%">object</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%">val</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%">7</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">val_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%">8</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">val_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%">9</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>QzuiFindConfigObject</em> API to search HTTP Server (powered
|
||
|
|
by Apache) configuration file for the object (and possibly value) specified
|
||
|
|
and returns a handle to it. If ″start″ is not specified, the configuration
|
||
|
|
file scope is used. If a value is specified, the value is tokenized and compared
|
||
|
|
with the tokens of the matching keywords. For example, if the keyword is ″BrowserMatch″
|
||
|
|
and the value is ″Mozilla/2″ the search would find ″BrowserMatch Mozilla/2
|
||
|
|
nokeepalive″. Also, the ″val″ field would contain ″Mozilla/2 nokeepalive″.
|
||
|
|
You need only pass the object type and keyword. For example, to find a ″Port″
|
||
|
|
directive, set the object type to 1, the keyword to ″Port″ and fdata_size
|
||
|
|
to 8. If the value field is not needed, set ″val_size″ to 0.</p>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="authoritylocks"><a name="authoritylocks"><!-- --></a><h2 class="topictitle2">Authorities and locks</h2>
|
||
|
|
<div><p>None.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="required"><a name="required"><!-- --></a><h2 class="topictitle2">Required parameter group</h2>
|
||
|
|
<div><dl><dt class="dlterm"><strong>cfg</strong></dt>
|
||
|
|
<dd>INPUT:BINARY(4) <p>Handle to the configuration file.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>fdata</strong></dt>
|
||
|
|
<dd>INPUT:CHAR(*) <p>Find data in format CFGF0110.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>fdata_size</strong></dt>
|
||
|
|
<dd>INPUT:BINARY(4) <p>Size of Find data format buffer.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>format</strong></dt>
|
||
|
|
<dd>INPUT:CHAR(8) <p>Name of format (CFGF0110).</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>object</strong></dt>
|
||
|
|
<dd>OUTPUT:BINARY(4) <p>Handle to the object found (-1 indicates not found).</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>val</strong></dt>
|
||
|
|
<dd>OUTPUT:CHAR(*) <p>Contains the whole value of the configuration object
|
||
|
|
found.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>val_size</strong></dt>
|
||
|
|
<dd>INPUT:BINARY(4) <p>Size of value buffer.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>val_actlen</strong></dt>
|
||
|
|
<dd>OUTPUT:BINARY(4) <p>Actual size of value.</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="cfgf0110_format"><a name="cfgf0110_format"><!-- --></a><h2 class="topictitle2">CFGF0110 format</h2>
|
||
|
|
<div><p>This data format is used by QzuiFindConfigObject 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="d0e226">Offset</th>
|
||
|
|
<th valign="top" id="d0e228">Type</th>
|
||
|
|
<th valign="top" id="d0e230">Field</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e226 ">0</td>
|
||
|
|
<td valign="top" headers="d0e228 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e230 ">Object type (0=directive, 1=scope)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e226 ">4</td>
|
||
|
|
<td valign="top" headers="d0e228 ">Char(40)</td>
|
||
|
|
<td valign="top" headers="d0e230 ">Keyword object to search for (required)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e226 ">44</td>
|
||
|
|
<td valign="top" headers="d0e228 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e230 ">Case sensitive (0=insensitive, 1=sensitive)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e226 ">48</td>
|
||
|
|
<td valign="top" headers="d0e228 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e230 ">Where to search (0=entire configuration, 1=with scope
|
||
|
|
specified in "Start", 2=start search at object specified in "Start", 3=start
|
||
|
|
search at scope specified in object start)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e226 ">52</td>
|
||
|
|
<td valign="top" headers="d0e228 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e230 ">Start - the search start handle (0 if no start is to
|
||
|
|
be used)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e226 ">56</td>
|
||
|
|
<td valign="top" headers="d0e228 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e230 ">Value when searching (0=no, 1=yes)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e226 ">60</td>
|
||
|
|
<td valign="top" headers="d0e228 ">Char(100)</td>
|
||
|
|
<td valign="top" headers="d0e230 ">Value of object to search for</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>CPF3CF1 E</strong></dt>
|
||
|
|
<dd>Error code parameter not valid.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>HTPA001 E</strong></dt>
|
||
|
|
<dd>Input parameter &1 not valid.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>HTPA106 E</strong></dt>
|
||
|
|
<dd>Input configuration handle not valid.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>HTPA121 E</strong></dt>
|
||
|
|
<dd>Object handle in parameter &1 not valid.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>HTPA122 E</strong></dt>
|
||
|
|
<dd>Object handle in parameter &1 not a scope.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>HTPA123 E</strong></dt>
|
||
|
|
<dd>No matching object found.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|