ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/rmvenvvar.htm

158 lines
4.7 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<!doctype html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><META http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Remove Environment Variable (RMVENVVAR)</title>
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body bgcolor="white">
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<a name="RMVENVVAR.Top_Of_Page"></a>
<h2>Remove Environment Variable (RMVENVVAR)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>All environments (*ALL)<br>
<b>Threadsafe: </b>Yes
</td>
<td valign="top" align="right">
<a href="#RMVENVVAR.PARAMETERS.TABLE">Parameters</a><br>
<a href="#RMVENVVAR.COMMAND.EXAMPLES">Examples</a><br>
<a href="#RMVENVVAR.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="RMVENVVAR"></a>
<p>The Remove Environment Variable (RMVENVVAR) command removes an environment variable (or all environment variables) that exists.
</p>
<p><b>Restriction:</b> You must have *JOBCTL special authority to use this command to remove system-level environment variables.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RMVENVVAR.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="RMVENVVAR.PARAMETERS.TABLE">Parameters</a></h3>
<table border="1" cellpadding="4" cellspacing="0">
<!-- col1="10" col2="15" col3="30" col4="10" -->
<tr>
<th bgcolor="aqua" valign="bottom" align="left">Keyword</th>
<th bgcolor="aqua" valign="bottom" align="left">Description</th>
<th bgcolor="aqua" valign="bottom" align="left">Choices</th>
<th bgcolor="aqua" valign="bottom" align="left">Notes</th>
</tr>
<tr>
<td valign="top"><a href="#RMVENVVAR.ENVVAR"><b>ENVVAR</b></a></td>
<td valign="top">Environment variable</td>
<td valign="top"><i>Character value</i>, *ALL</td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#RMVENVVAR.LEVEL"><b>LEVEL</b></a></td>
<td valign="top">Level</td>
<td valign="top"><b><u>*JOB</u></b>, *SYS</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#RMVENVVAR.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="RMVENVVAR.ENVVAR"></a>
<h3>Environment variable (ENVVAR)</h3>
<p>Specifies the name of the environment variable to be removed. If an environment variable by this name does not exist at the specified level (LEVEL parameter), error message CPFA981 is issued.
</p>
<p>If the special value of *ALL is specified, then all environment variables at the specified level (LEVEL parameter) are removed.
</p>
<p>
<b>Note: </b>The case is preserved when lowercase characters are specified.
</p>
<p>If an apostrophe is intended, two apostrophes must be used ('').
</p>
<p>This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RMVENVVAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RMVENVVAR.LEVEL"></a>
<h3>Level (LEVEL)</h3>
<p>Specifies the level of the environment variable.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*JOB</u></b></dt>
<dd>This is a job-level environment variable.
</dd>
<dt><b>*SYS</b></dt>
<dd>This is a system-level environment variable.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RMVENVVAR.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RMVENVVAR.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Remove a Job-level Environment Variable</b>
</p>
<p>
<pre>
RMVENVVAR ENVVAR(altdir)
</pre>
</p>
<p>This command removes the job-level environment variable named altdir.
</p>
<p><b>Example 2: Remove a System-level Environment Variable</b>
</p>
<p>
<pre>
RMVENVVAR ENVVAR(home) TYPE(*SYS)
</pre>
</p>
<p>This command removes the system-level environment variable named home.
</p>
<p><b>Example 3: Remove All Job-level Environment Variables</b>
</p>
<p>
<pre>
RMVENVVAR ENVVAR(*ALL)
</pre>
</p>
<p>This commands removes all job-level environment variables.
</p>
<p><b>Example 4: Remove All System-level Environment Variables</b>
</p>
<p>
<pre>
RMVENVVAR ENVVAR(*ALL) LEVEL(*SYS)
</pre>
</p>
<p>This commands removes all system-level environment variables.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RMVENVVAR.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RMVENVVAR.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPFA981</b></dt>
<dd>Environment variable does not exist.
</dd>
<dt><b>CPFA98E</b></dt>
<dd>*JOBCTL special authority required to update system-level environment variables.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RMVENVVAR.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>