書式
#include <stdlib.h>
int setenv(const char *name, const char *value, int overwrite);
int unsetenv(const char *name);
glibc 向けの機能検査マクロの要件 (feature_test_macros(7) 参照):
setenv(), unsetenv():
- _BSD_SOURCE || _POSIX_C_SOURCE >= 200112L || _XOPEN_SOURCE >= 600
説明
setenv() 関数は、name が存在しない場合 環境変数 name に値 value を設定し、環境に追加する。 name が環境に存在する場合、overwrite が 0 以外ならば その値を value に変更し、overwrite が 0 ならば name の値を変更しない (setenv() は成功のステータスを返す)。 この関数は、 (putenv(3) と違い) name と value により参照される文字列のコピーを行う。unsetenv() 関数は、変数 name を環境から削除する。 name が環境にない場合、この関数は成功し、環境は変更されない。
返り値
setenv() 関数は、成功すると 0 を返す。 エラーの場合、-1 を返し、 errno にエラーの原因を示す値がセットされる。unsetenv() 関数は、成功すると 0 を返す。 エラーの場合は -1 を返し、 errno を設定してエラーの原因を示す。
エラー
- EINVAL
- name が NULL であるか、長さが 0 の文字列を指しているか、 '=' 文字が含まれている。
- ENOMEM
- 環境に新しい変数を追加するのに十分なメモリがない。
準拠
4.3BSD, POSIX.1-2001.注意
POSIX.1-2001 は、 setenv() や unsetenv() がリエントラント (再入可能) であることを要求していない。glibc 2.2.2 以前では、 unsetenv() は 返り値が void のプロトタイプであった。 もっと最近の glibc 版は、「書式」セクションで示しているように POSIX.1-2001 互換のプロトタイプである。
バグ
POSIX.1-2001 では 「name に '=' 文字が含まれる場合、 setenv() はエラー EINVAL で失敗すべきである」と述べられている。 しかし 2.3.4 より前のバージョンの glibc では、 name に '=' 文字が含まれるのを許している。この文書について
この man ページは Linux man-pages プロジェクトのリリース 3.65 の一部 である。プロジェクトの説明とバグ報告に関する情報は http://www.kernel.org/doc/man-pages/ に書かれている。