ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzaie_5.4.0.1/rzaieapi_qzhbcgiutils.htm

133 lines
6.9 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="Produce Full HTTP Response (QzhbCgiUtils) 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_qzhbcgiutils" />
<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>Produce Full HTTP Response (QzhbCgiUtils) API</title>
</head>
<body id="rzaieapi_qzhbcgiutils"><a name="rzaieapi_qzhbcgiutils"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<!--Java sync-link--><h1 class="topictitle1">Produce Full HTTP Response (QzhbCgiUtils) 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%">Command string</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%">2</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>
</tbody>
</table>
</div>
<p>Use <em>QzhbCgiUtils</em> API to produce a full HTTP 1.0/1.1 response for
non-parsed header CGI programs. This API provides functionality similar to
the cgiutils command used by other HTTP Server platforms.</p>
</div>
<div class="nested1" id="required"><a name="required"><!-- --></a><h2 class="topictitle2">Required parameter group</h2>
<div><dl><dt class="dlterm"><strong>Command string</strong></dt>
<dd>INPUT:CHAR(*) <p>The command string is a null ended string of flags and
modifiers. Each flag must be separated by at least one space. The following
flags are supported:</p>
<dl><dt class="dlterm"><strong>-nodate</strong></dt>
<dd>Does not return the Date: header to the browser.</dd>
</dl>
<dl><dt class="dlterm"><strong>-noel</strong></dt>
<dd>Does not return a blank line after headers. This is useful if you want
other MIME headers after the initial header lines.</dd>
</dl>
<dl><dt class="dlterm"><strong>-status</strong> <em>nnn</em></dt>
<dd>Returns full HTTP response with status code <em>nnn</em>, instead of only
a set of HTTP headers. Do not use this flag if you only want the Expires:
header.</dd>
</dl>
<dl><dt class="dlterm"><strong>-reason</strong> <em>explanation</em></dt>
<dd>Specifies the reason line for the HTTP response. You can only use this
flag with the <strong>-status</strong> flag. If the explanation text contains more than
one word, you must enclose it in parentheses.</dd>
</dl>
<dl><dt class="dlterm"><strong>-ct [</strong><em>type/subtype</em><strong>]</strong></dt>
<dd>Specifies MIME Content-Type header to return to the browser. If you omit
the type/subtype, the MIME content type is set to the default text/plan.</dd>
</dl>
<dl><dt class="dlterm"><strong>-charset</strong> <em>character-set</em></dt>
<dd>Used with the <strong>-ct</strong> flag to specify the charset tag associated with
the text Content-Types.</dd>
</dl>
<dl><dt class="dlterm"><strong>-ce</strong> <em>encoding</em></dt>
<dd>Specifies MIME Content-Encoding header to return to the browser.</dd>
</dl>
<dl><dt class="dlterm"><strong>-cl</strong> <em>language-code</em></dt>
<dd>Specifies MIME Content-Language header to return to the browser.</dd>
</dl>
<dl><dt class="dlterm"><strong>-length</strong> <em>nnn</em></dt>
<dd>Specifies MIME Content-Length header to return to the browser.</dd>
</dl>
<dl><dt class="dlterm"><strong>-expires</strong> <em>Time-Spec</em></dt>
<dd>Specifies MIME Expires header to return to the browser. This flag specifies
the time to live in any combination of years, months, days, hours, minutes,
and seconds. The time must be enclosed in parentheses. For example:<pre>-expires (2 days 12 hours)</pre>
</dd>
</dl>
<dl><dt class="dlterm"><strong>-expires now</strong></dt>
<dd>Produces an Expires: header that matches the Date: header to return to
the browser.</dd>
</dl>
<dl><dt class="dlterm"><strong>-uri</strong> <em>URI</em></dt>
<dd>Specifies the Universal Resource Identifier (URI) for the returned document.
URI can be considered the same as URL.</dd>
</dl>
<dl><dt class="dlterm"><strong>-extra</strong> <em>xxx: yyy</em></dt>
<dd>Specifies an extra header that cannot otherwise be specified.</dd>
</dl>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Error Code</strong></dt>
<dd>I/O:CHAR(*) <p>The structure in which to return error information. For
the format of the structure and for details on how to process API errors,
see the API error reporting topic in the iSeries™ Information Center.</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>CPF24B4 E</strong></dt>
<dd>Severe Error while addressing parameter list.</dd>
</dl>
<dl><dt class="dlterm"><strong>CPF3C17 E</strong></dt>
<dd>Error occurred with input data parameter.</dd>
</dl>
<dl><dt class="dlterm"><strong>CPF3CF1 E</strong></dt>
<dd>Error code parameter not valid.</dd>
</dl>
</div>
</div>
</body>
</html>