名前

strerror, strerror_r, strerror_l - エラー番号を説明する文字列を返す。

書式

#include <string.h>

char *strerror(int errnum);

int strerror_r(int errnum, char *buf, size_t buflen);


            /* XSI-compliant */

char *strerror_r(int errnum, char *buf, size_t buflen);


            /* GNU-specific */
char *strerror_l(int errnum, locale_t locale);

glibc 向けの機能検査マクロの要件 (feature_test_macros(7) 参照):

strerror_r():

説明

strerror() 関数は、引き数 errnum で渡されたエラーコードについての説明が入った文字列へのポインターを返す。 可能であるならば、適切な言語を選択するために、 現在のロケールの LC_MESSAGES を使う。(例えば、 errnum が EINVAL の場合、説明として "Invalid argument" が返される。) この文字列は、アプリケーションで変更してはならないが、 これ以降に行われる strerror() や strerror_l() の呼び出しで変更されても構わない。 perror(3) などの、これ以外のライブラリ関数ではこの文字列は変更されない。

返り値

関数 strerror(), strerror_l() と GNU 固有の関数 strerror_r() はエラー内容を説明する文字列を返す。 エラー番号が未知の場合は "Unknown error nnn" という メッセージを返す。

XSI 準拠の strerror_r() 関数は成功すると 0 を返す。エラーの場合には、 (glibc 2.13 以降では) (正の) エラー番号が返され、(バージョン 2.13 より前 の glibc では) -1 が返され、 errno にエラーを示す値がセットされる。

POSIX.1-2001 と POSIX.1-2008 では、 strerror() や strerror_l() が成功した場合は errno を変更せずに元のままにしなければならないとされている。関数のどの返り値もエラーを示すために予約されていないので、エラーをチェックしたいアプリケーションは呼び出しを行う前に errno を 0 に初期化し、呼び出しの後で errno をチェックすべき点に注意すること。

エラー

EINVAL

errnum の値が有効なエラー番号ではない。

ERANGE

エラーコードを説明する文字列のために、充分な領域が確保できなかった。

属性

バージョン

strerror_l() 関数は glibc 2.6 で初めて登場した。

準拠

strerror() は POSIX.1-2001, POSIX.1-2008, C89, C99 で規定されている。 strerror_r() は POSIX.1-2001 と POSIX.1-2008 で規定されている。

strerror_l() は POSIX.1-2008 で規定されている。

GNU 仕様の strerror_r() 関数は非標準の拡張である。

POSIX.1-2001 は、 strerror() がエラーに遭遇した場合に errno をセッ トすることを認めているが、エラー発生時に関数の結果として どんな値を返す べきかを規定してない。 あるシステムでは、 エラー番号が未知の場合、 strerror() は NULL を返す。 他のシステムでは、 エラー番号が未知の場 合、 strerror() は "Error nnn occurred" といった文字列を返し、 errno に EINVAL をセットする。 C99 と POSIX.1-2008 では、返り値が NULL 以外になることが求められている。

関連項目

err(3), errno(3), error(3), perror(3), strsignal(3), locale(7)

この文書について

この man ページは Linux man-pages プロジェクトのリリース 3.79 の一部 である。プロジェクトの説明とバグ報告に関する情報は http://www.kernel.org/doc/man-pages/ に書かれている。