151 lines
7.9 KiB
HTML
151 lines
7.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="Get environment variable with CCSID (QzsrGetEnvCCSID) 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>Get environment variable with CCSID (QzsrGetEnvCCSID) 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">Get environment variable with CCSID (QzsrGetEnvCCSID) 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="3" valign="top">Required parameter group:</td>
|
|
</tr>
|
|
<tr><td valign="top" width="33.42318059299191%">Receiver variable</td>
|
|
<td valign="top" width="33.153638814016176%">Output</td>
|
|
<td valign="top" width="33.42318059299191%">Char(*)</td>
|
|
</tr>
|
|
<tr><td valign="top" width="33.42318059299191%">Length of receiver variable</td>
|
|
<td valign="top" width="33.153638814016176%">Input</td>
|
|
<td valign="top" width="33.42318059299191%">Binary(4)</td>
|
|
</tr>
|
|
<tr><td valign="top" width="33.42318059299191%">Length of response</td>
|
|
<td valign="top" width="33.153638814016176%">Output</td>
|
|
<td valign="top" width="33.42318059299191%">Binary(4)</td>
|
|
</tr>
|
|
<tr><td valign="top" width="33.42318059299191%">Request variable</td>
|
|
<td valign="top" width="33.153638814016176%">Input</td>
|
|
<td valign="top" width="33.42318059299191%">Char(*)</td>
|
|
</tr>
|
|
<tr><td valign="top" width="33.42318059299191%">Length of request variable</td>
|
|
<td valign="top" width="33.153638814016176%">Input</td>
|
|
<td valign="top" width="33.42318059299191%">Binary(4)</td>
|
|
</tr>
|
|
<tr><td valign="top" width="33.42318059299191%">CCSID of request variable</td>
|
|
<td valign="top" width="33.153638814016176%">Input</td>
|
|
<td valign="top" width="33.42318059299191%">Binary(4)</td>
|
|
</tr>
|
|
<tr><td valign="top" width="33.42318059299191%">CCSID of returned environment variable</td>
|
|
<td valign="top" width="33.153638814016176%">Input</td>
|
|
<td valign="top" width="33.42318059299191%">Binary(4)</td>
|
|
</tr>
|
|
<tr><td valign="top" width="33.42318059299191%">Error Code</td>
|
|
<td valign="top" width="33.153638814016176%">I/O</td>
|
|
<td valign="top" width="33.42318059299191%">Char(*)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p>The <em>QzsrvGetEnvCCSID</em> API allows you to get the value set by the
|
|
server for a particular HTTP environment variable using CCSID support for
|
|
input and output values.</p>
|
|
</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 output variable that contains the value set by the
|
|
server for the requested environment variable. This value will be returned
|
|
in the CCSID specified for the returned environment variable. </p>
|
|
</dd>
|
|
</dl>
|
|
<p>The output variable that contains the value set by the server for the requested
|
|
environment variable. This value will be returned in the CCSID specified for
|
|
the returned environment variable. </p>
|
|
<dl><dt class="dlterm"><strong>Length of receiver variable</strong></dt>
|
|
<dd>INPUT:BINARY(4) <p>The input variable containing the length of the space
|
|
provided to receive the environment variable value.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>Length of response</strong></dt>
|
|
<dd>OUTPUT:BINARY(4)<p>The output variable that contains the length of the
|
|
environment variable value. When the API is unable to determine the value
|
|
for the requested environment variable, the length of the environment variable
|
|
value is set to zero. When the size required for the environment variable
|
|
value is larger than the length of the receiver variable, the size required
|
|
to receive the value is returned.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>Request variable</strong></dt>
|
|
<dd>INPUT:CHAR(*)<p>The input variable containing the desired environment
|
|
variable name.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>Length of request variable</strong></dt>
|
|
<dd>INPUT:BINARY(4)<p>The input variable containing the length (without trailing
|
|
blanks) of the desired environment variable name.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>CCSID of request variable</strong></dt>
|
|
<dd>INPUT:BINARY(4)<div class="p">The CCSID to be used for the encoding of the request
|
|
variable. The valid values for this parameter are:<ul><li><strong>0</strong> : The CCSID of the job.</li>
|
|
<li><strong>1-65533</strong> : A valid CCSID in this range must be specified or an error
|
|
is returned.</li>
|
|
</ul>
|
|
</div>
|
|
</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>CCSID of returned environment variable</strong></dt>
|
|
<dd>INPUT:BINARY(4)<div class="p">The CCSID to be used for the encoding of the returned
|
|
environment variable. The valid values for this parameter are: <ul><li><strong>0 </strong>: The CCSID of the job.</li>
|
|
<li><strong>1-65533 </strong>: A valid CCSID in this range must be specified or an error
|
|
is returned. </li>
|
|
</ul>
|
|
</div>
|
|
</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>Error code</strong></dt>
|
|
<dd>I/O:CHAR(*)<p>The structure in which to return error information. Error
|
|
messages are added to the error log or script log except for those listed
|
|
below. 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>CPF3CF1 E</strong></dt>
|
|
<dd>Error code parameter not valid.</dd>
|
|
</dl>
|
|
<div class="note"><span class="notetitle">Note:</span> The Environment Variable APIs provide the getenv() (Get Value of Environment
|
|
Variable) function necessary to retrieve environment variables in ILE C.
|
|
Programs that need CCSID conversion support for environment variables should
|
|
use the <a href="rzaieapi_qzsrputenvccsid.htm">Put environment variable with CCSID (QzsrPutEnvCCSID) API</a>.</div>
|
|
</div>
|
|
</div>
|
|
|
|
</body>
|
|
</html> |