117 lines
6.2 KiB
HTML
117 lines
6.2 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="Put Environment Variable (QtmhPutEnv) 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_qtmhputenv" />
|
|
<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>Put Environment Variable (QtmhPutEnv) API</title>
|
|
</head>
|
|
<body id="rzaieapi_qtmhputenv"><a name="rzaieapi_qtmhputenv"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<!--Java sync-link--><h1 class="topictitle1">Put Environment Variable (QtmhPutEnv) 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%">Environment 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%">Length of environment string</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%">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>The QtmhPutEnv API allows you to set or create a job-level environment
|
|
variable. This is useful for communication between programs running in the
|
|
same job, such as your program and the Net.Data<sup>®</sup> language environment DTW_SYSTEM.</p>
|
|
</div>
|
|
<div class="nested1" id="required"><a name="required"><!-- --></a><h2 class="topictitle2">Required parameter group</h2>
|
|
<div><dl><dt class="dlterm"><strong>Environment string</strong></dt>
|
|
<dd>INPUT:CHAR(*)<p>The input string of the form: ″envVar=value″. Where ″envVar″
|
|
is the name of the new or existing environment variable, and ″value″ is the
|
|
value you want to set the environment variable. Note that they are both case
|
|
sensitive. The server expects this value to be in the CCSID of the job.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>Length of environment string</strong></dt>
|
|
<dd>INPUT:BINARY(4)<p>The input variable that contains the length of the environment
|
|
string parameter (without trailing blanks). For example, the length of the
|
|
environment string ″envVar=value″ is twelve.</p>
|
|
</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>CPF3021 E</strong></dt>
|
|
<dd>The value specified for the argument is not correct.</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>
|
|
<dl><dt class="dlterm"><strong>CPF3408 E</strong></dt>
|
|
<dd>The address used for an argument is not correct.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>CPF3460 E</strong></dt>
|
|
<dd>Storage allocation request failed.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>CPF3474 E</strong></dt>
|
|
<dd>Unknown system state.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>CPF3484 E</strong></dt>
|
|
<dd>A damaged object was encountered.</dd>
|
|
</dl>
|
|
<div class="note"><span class="notetitle">Note:</span> The Environment Variable APIs provide the putenv() (Put Value in Environment
|
|
Variable) function necessary to set (or create and set) an environment variable.
|
|
Therefore, programs written in ILE C do not need to use the QtmhPutEnv() API.
|
|
This API, for ILE C, is more difficult to use (and is slower) than the putenv()
|
|
API on which it is based.</div>
|
|
<p>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>.</p>
|
|
</div>
|
|
</div>
|
|
|
|
</body>
|
|
</html> |