strerrorのヘルプ・マニュアル
日本語 英語
strerror --help
man strerror
STRERROR(3) Linux Programmer’s Manual STRERROR(3)
名前
strerror, strerror_r - エラー番号を説明する文字列を返す。
書式
#include
char *strerror(int errnum);
char *strerror_r(int errnum, char *buf, size_t buflen);
glibc 向けの機能検査マクロの要件 (feature_test_macros(7) 参照):
次の場合には XSI 準拠のバージョンの strerror_r() が提供される:
(_POSIX_C_SOURCE >= 200112L || _XOPEN_SOURCE >= 600) && ! _GNU_SOURCE
説明
strerror() 関数は、引き数 errnum で渡されたエラーコードについての説明が
入った文字列へのポインタを返す。可能であるならば、適切な言語を選択す る
ために、現在のロケールの LC_MESSAGES を使う。この文字列は、アプリケーシ
ョンで変更してはならないが、その後に起こる perror(3) や strerror() の呼
び 出しで変更されても構わない。この文字列を変更するライブラリ関数はない
。
strerror_r() 関数は strerror() と似ているが、スレッドセーフである。この
関数には二種類のバージョンが存在し、 POSIX.1-2001 で規定された XSI 準拠
のバージョン (glibc 2.3.4 以降で利用可能) と、 GNU 仕様のバ ー ジ ョ ン
(glibc 2.0 以降で利用可能) である。「書式」の節に記載された機能検査マク
ロの場合には、 XSI 準拠のバージョンが提供される。それ以外の場合には GNU
仕 様のバージョンが提供される。機能検査マクロが一つも明示的に定義されな
い場合、 (glibc 2.4 以降では) デフォルトで _POSIX_SOURCE は 値 200112l
で定義され、その結果 XSI 準拠のバージョンの strerror_r() がデフォルトで
提供される。
移植性が必要なアプリケーションでは、 XSI 準拠の strerror_r() を使う方が
よい。この関数は、ユーザーから提供される長さ buflen のバッファ buf にエ
ラー文字列を返す。
GNU 仕様の strerror_r() は、エラーメッセージを格納した文字列へのポイ ン
タを返す。返り値は、この関数が buf に格納した文字列へのポインタか、何ら
かの (不変な) 静的な文字列へのポインタ、のいずれかとなる (後者の場合 は
buf は使用されない)。 buf に文字列が格納される場合は、最大で buflen バ
イトが格納され (buflen が小さ過ぎたときには文字列は切り詰められる)、 文
字列には必ず終端ヌル文字が含まれる。
返り値
strerror() と strerror_r() はエラー内容を説明する文字列を返す。エラー番
号が未知の場合は "Unknown error nnn" というメッセージを返す。
XSI 準拠の strerror_r() 関数は成功すると 0 を返す。エラーの場合に は 、
-1 を返し、 errno にエラー内容を示す値をセットする。
エラー
EINVAL errnum の値が有効なエラー番号ではない。
ERANGE エラーコードを説明する文字列のために、充分な領域が確保できなかっ
た。
準拠
strerror() は POSIX.1-2001, C89, C99 で規定されている。 strerror_r() は
POSIX.1-2001 で規定されている。
GNU 仕様の strerror_r() 関数は非標準の拡張である。
POSIX.1-2001 は、 strerror() がエラーに遭遇した場合に errno をセットす
ることを認めているが、エラー発生時に関数の結果としてどんな値を返すべ き
かを規定してない。あるシステムでは、エラー番号が未知の場合、 strerror()
は NULL を返す。他のシステムでは、エラー番号が未知の場合 、 strerror()
は "Error nnn occurred" といった文字列を返し、 errno に EINVAL をセット
する。
関連項目
err(3), errno(3), error(3), perror(3), strsignal(3)
2009-03-30 STRERROR(3)
STRERROR(3) Linux Programmer’s Manual STRERROR(3)
NAME
strerror, strerror_r - return string describing error number
SYNOPSIS
#include
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 */
Feature Test Macro Requirements for glibc (see feature_test_macros(7)):
The XSI-compliant version of strerror_r() is provided if:
(_POSIX_C_SOURCE >= 200112L || _XOPEN_SOURCE >= 600) && ! _GNU_SOURCE
Otherwise, the GNU-specific version is provided.
DESCRIPTION
The strerror() function returns a pointer to a string that describes
the error code passed in the argument errnum, possibly using the
LC_MESSAGES part of the current locale to select the appropriate lan-
guage. This string must not be modified by the application, but may be
modified by a subsequent call to perror(3) or strerror(). No library
function will modify this string.
The strerror_r() function is similar to strerror(), but is thread safe.
This function is available in two versions: an XSI-compliant version
specified in POSIX.1-2001 (available since glibc 2.3.4), and a GNU-spe-
cific version (available since glibc 2.0). The XSI-compliant version
is provided with the feature test macros settings shown in the SYNOP-
SIS; otherwise the GNU-specific version is provided. If no feature
test macros are explicitly defined, then (since glibc 2.4)
_POSIX_SOURCE is defined by default with the value 200112L, so that the
XSI-compliant version of strerror_r() is provided by default.
The XSI-compliant strerror_r() is preferred for portable applications.
It returns the error string in the user-supplied buffer buf of length
buflen.
The GNU-specific strerror_r() returns a pointer to a string containing
the error message. This may be either a pointer to a string that the
function stores in buf, or a pointer to some (immutable) static string
(in which case buf is unused). If the function stores a string in buf,
then at most buflen bytes are stored (the string may be truncated if
buflen is too small) and the string always includes a terminating null
byte.
RETURN VALUE
The strerror() and the GNU-specific strerror_r() functions return the
appropriate error description string, or an "Unknown error nnn" message
if the error number is unknown.
The XSI-compliant strerror_r() function returns 0 on success; on error,
-1 is returned and errno is set to indicate the error.
ERRORS
EINVAL The value of errnum is not a valid error number.
ERANGE Insufficient storage was supplied to contain the error descrip-
tion string.
CONFORMING TO
strerror() is specified by POSIX.1-2001, C89, C99. strerror_r() is
specified by POSIX.1-2001.
The GNU-specific strerror_r() function is a non-standard extension.
POSIX.1-2001 permits strerror() to set errno if the call encounters an
error, but does not specify what value should be returned as the func-
tion result in the event of an error. On some systems, strerror()
returns NULL if the error number is unknown. On other systems, str-
error() returns a string something like "Error nnn occurred" and sets
errno to EINVAL if the error number is unknown.
SEE ALSO
err(3), errno(3), error(3), perror(3), strsignal(3)
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/.
2009-03-30 STRERROR(3)