<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation"> <title>Qp0zDltSysEnv()--Delete a System-Level Environment Variable</title> <!-- Begin Header Records ========================================== --> <!-- 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. --> <!-- Change History: --> <!-- YYMMDD USERID Change description --> <!-- Direct1 SCRIPT J converted by B2H R4.1 (346) (CMS) by V2KEA304 --> <!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 --> <!-- This file has undergone html cleanup on 04/29/02 by JET --> <!-- End Header Records --> <link rel="stylesheet" type="text/css" href="../rzahg/ic.css"> </head> <body> <!-- Java sync-link --> <script language="Javascript" src="../rzahg/synch.js" type="text/javascript"> </script> <a name="Top_Of_Page"></a> <h2>Qp0zDltSysEnv()--Delete a System-Level Environment Variable</h2> <div class="box" style="width: 70%;"> <br> Syntax <pre> #include <qp0z1170.h> int Qp0zDltSysEnv(const char <em>*name</em>, void <em>*reserved</em>); </pre> Service Program Name: QP0ZSYSE<br> <!-- iddvc RMBR --> <br> Default Public Authority: *USE<br> <!-- iddvc RMBR --> <br> Threadsafe: Yes<br> <!-- iddvc RMBR --> <br> </div> <p>The <strong>Qp0zDltSysEnv()</strong> function deletes a single system-level environment variable or deletes all system-level environment variables. If the <em>name</em> parameter is NULL, all system-level environment variables are deleted.</p> <p>The <em>name</em> parameter does not include the equal (=) symbol or the <samp>value</samp> part of the environment variable <samp>name=value</samp> pair.</p> <br> <h3>Parameters</h3> <dl> <dt><strong><em>name</em></strong></dt> <dd>(Input) The name of the environment variable to delete.<br> </dd> <dt><strong><em>reserved</em></strong></dt> <dd>(Input) Reserved for future use. Currently, the only value allowed is NULL.</dd> </dl> <br> <h3>Authorities</h3> <p>*JOBCTL special authority is required to delete a system-level environment variable.</p> <br> <h3>Return Value</h3> <table cellpadding="5"> <!-- cols="5 95" --> <tr> <td align="left" valign="top"><em>0</em></td> <td align="left" valign="top"><strong>Qp0zDltSysEnv()</strong> was successful.</td> </tr> <tr> <td align="left" valign="top"><em>errval</em></td> <td align="left" valign="top"><strong>Qp0zDltSysEnv()</strong> was not successful. <em>errval</em> is set to indicate the error.</td> </tr> </table> <br> <br> <h3>Error Conditions</h3> <p>If <strong>Qp0zDltSysEnv()</strong> is not successful, <em>errval</em> indicates one of the following errors.</p> <dl compact> <dt><em>[EFAULT]</em></dt> <dd> <p>The address used for an argument is not correct.</p> <p>In attempting to use an argument in a call, the system detected an address that is not valid.</p> <p>While attempting to access a parameter passed to this function, the system detected an address that is not valid.</p> </dd> <dt><em>[EINVAL]</em></dt> <dd> <p>The value specified for the argument is not correct.</p> <p>A function was passed incorrect argument values, or an operation was attempted on an object and the operation specified is not supported for that type of object.</p> <p>An argument value is not valid, out of range, or NULL.</p> <p>The value for the <em>reserved</em> parameter was not NULL.</p> </dd> <dt><em>[ENOENT]</em></dt> <dd> <p>No such path or directory.</p> <p>The directory or a component of the path name specified does not exist.</p> <p>A named file or directory does not exist or is an empty string.</p> <p>The parameter <samp>name</samp> is not NULL and does not point to an environment variable name that currently exists in the environment list.</p> </dd> <dt><em>[EPERM]</em></dt> <dd> <p>Operation not permitted.</p> <p>You must have appropriate privileges or be the owner of the object or other resource to do the requested operation.</p> <p>You must have *JOBCTL special authority to delete a system-level environment variable.</p> </dd> <dt><em>[EUNKNOWN]</em></dt> <dd> <p>Unknown system state.</p> <p>The operation failed because of an unknown system state. See any messages in the job log and correct any errors that are indicated, then retry the operation.</p> </dd> </dl> <br> <h3>Related Information</h3> <ul> <li>The <<strong>qp0z1170.h</strong>> file (see <a href="unix13.htm"> Header Files for UNIX-Type Functions</a>)</li> <li><a href="evgetenv.htm">getenv()</a>--Get Value of Environment Variable</li> <li><a href="evputenv.htm">putenv()</a>--Change or Add Environment Variable</li> <li><a href="evdltenv.htm">Qp0zDltEnv()</a>--Delete an Environment Variable</li> <li><a href="evgetall.htm">Qp0zGetAllSysEnv()</a>--Get All System-Level Environment Variables</li> <li><a href="evgenvxt.htm">Qp0zGetEnv()</a>--Get Value of Environment Variable (Extended)</li> <li><a href="evgetsev.htm">Qp0zGetSysEnv()</a>--Get Value of System-Level Environment Variable</li> <li><a href="evinenv.htm">Qp0zInitEnv()</a>--Initialize Environment for Variables</li> <li><a href="evpenvxt.htm">Qp0zPutEnv()</a>--Change or Add Environment Variable (Extended)</li> <li><a href="evputsev.htm">Qp0zPutSysEnv()</a>--Change or Add a System-Level Environment</li> </ul> <br> <h3>Example</h3> <p>See <a href="../apiref/aboutapis.htm#codedisclaimer">Code disclaimer information</a> for information pertaining to code examples.</p> <p>See the example of using <strong>Qp0zDltSysEnv()</strong> in <a href= "evputsev.htm">Qp0zPutSysEnv()</a>--Change or Add a System-Level Environment.</p> <br> <hr> API introduced: V4R4 <hr> <center> <table cellpadding="2" cellspacing="2"> <tr align="center"> <td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href= "unix.htm">UNIX-Type APIs</a> | <a href="aplist.htm">APIs by category</a></td> </tr> </table> </center> </body> </html>