clearenvのヘルプ・マニュアル
日本語 英語
clearenv --help
man clearenv
CLEARENV(3) Linux Programmer’s Manual CLEARENV(3)
名前
clearenv - 環境 (environment) をクリアする
書式
#include
int clearenv(void);
glibc 向けの機能検査マクロの要件 (feature_test_macros(7) 参照):
clearenv(): _SVID_SOURCE || _XOPEN_SOURCE
説明
clearenv() 関数は、名前と値が組になった全ての環境をクリアする。さらに外
部変数 environ の値を NULL にする。
返り値
clearenv() 関数は、成功した場合は 0 を返し、失敗した場合は 0 以外を返す
。
バージョン
libc4, libc5 では使用できない。 glibc 2.0 以降の glibc で使用できる。
準拠
(DG/UX, HP-UX, QNX, などの) 多くの Unix 系 OS。 (FORTRAN77 へのバインデ
ィングである) POSIX.9。 POSIX.1-1996 では clearenv() と putenv(3) は 採
用 されなかったが、方針が変更され、この標準規格の以降の号 (B.4.6.1 を参
照) では採用されることになった。しかし POSIX.1-2001 では putenv(3) しか
追加されず、 clearenv() の追加は否決された。
注意
こ の関数はセキュリティに考慮したアプリケーションで使われる。この関数が
使用できない場合は、
environ = NULL;
というように変数 environ を設定すればよい。
DG/UX と Tru64 man ページには次のように記され て い る ： environ が
putenv(3), getenv(3), clearenv() 関数以外で変更された場合、 clearenv()
はエラーを返し、プロセス環境は変更前のままにされる。
関連項目
getenv(3), putenv(3), setenv(3), unsetenv(3), environ(7)
Linux 2007-07-26 CLEARENV(3)
CLEARENV(3) Linux Programmer’s Manual CLEARENV(3)
NAME
clearenv - clear the environment
SYNOPSIS
#include
int clearenv(void);
Feature Test Macro Requirements for glibc (see feature_test_macros(7)):
clearenv(): _SVID_SOURCE || _XOPEN_SOURCE
DESCRIPTION
The clearenv() function clears the environment of all name-value pairs
and sets the value of the external variable environ to NULL.
RETURN VALUE
The clearenv() function returns zero on success, and a non-zero value
on failure.
VERSIONS
Not in libc4, libc5. In glibc since glibc 2.0.
CONFORMING TO
Various Unix variants (DG/UX, HP-UX, QNX, ...). POSIX.9 (bindings for
FORTRAN77). POSIX.1-1996 did not accept clearenv() and putenv(3), but
changed its mind and scheduled these functions for some later issue of
this standard (cf. B.4.6.1). However, POSIX.1-2001 only adds
putenv(3), and rejected clearenv().
NOTES
Used in security-conscious applications. If it is unavailable the
assignment
environ = NULL;
will probably do.
The DG/UX and Tru64 man pages write: If environ has been modified by
anything other than the putenv(3), getenv(3), or clearenv() functions,
then clearenv() will return an error and the process environment will
remain unchanged.
SEE ALSO
getenv(3), putenv(3), setenv(3), unsetenv(3), environ(7)
COLOPHON
This page is part of release 3.22 of the Linux man-pages project. A
description of the project, and information about reporting bugs, can
be found at http://www.kernel.org/doc/man-pages/.
Linux 2007-07-26 CLEARENV(3)