strerror, strerror_r − Obtenir le libellé d’un numéro d’erreur.

#include <string.h>

char *strerror (int errnum);

#define _XOPEN_SOURCE 600
char *strerror_r(int errnum, char *buf, size_t buflen);
                        /* strerror_r() spécifique GNU */

#include <string.h>

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

La fonction strerror() renvoie une chaîne décrivant le code d’erreur passé en argument errnum, en utilisant éventuellement la catégorie LC_MESSAGES de la localisation pour sélectionner la langue appropriée. Cette chaîne ne doit pas être modifiée par l’application, mais peut être écrasée par un appel ultérieur à perror() ou strerror(). Aucune autre fonction de bibliothèque ne modifie cette chaîne.

La fonction strerror_r() est identique à strerror() mais fonctionne correctement dans un environnement multi-threads. Cette fonction est disponible en deux versions : une version conforme XSI spécifiée dans POSIX.1-2001 et une version spécifique GNU (disponible depuis la glibc 2.0). Si _XOPEN_SOURCE est définie avec la valeur 600, c’est la version conforme XSI qui est fournie, sinon c’est la version spécifique GNU.

La version de strerror_r() conforme XSI est préférée pour les applications portables. Elle renvoie la chaîne dans le tampon buf de longueur buflen fourni par l’appelant.

La version de strerror_r() spécifique GNU renvoie un pointeur sur une chaîne contenant le message d’erreur. Cela peut être soit un pointeur vers une chaîne que la fonction stocke dans buf, soit un pointeur vers une chaîne statique (immuable) (auquel cas buf n’est pas utilisé). Si la fonction stocke une chaîne dans buf, au plus buflen octets sont stockés (la chaîne peut être tronquée si buflen est trop petit) et la chaîne inclut toujours l’octet nul de terminaison.

Les fonctions strerror() et strerror_r() renvoient la description correspondant au code transmis, ou un message « Unknown error nnn » si le numéro d’erreur n’existe pas.

La fonction strerror_r() conforme XSI renvoie 0 si elle réussit et −1 si elle échoue et écrit errno pour indiquer l’erreur.

EINVAL

La valeur de errnum n’est pas un code d’erreur valide.

ERANGE

Le tampon fourni n’est pas assez grand.

POSIX.1-2001.

La fonction strerror_r() spécifique GNU n’est pas une extension standard.

POSIX.1-2001. permet à strerror() d’écrire errno si l’appel rencontre une erreur mais ne spécifie pas quelle valeur devrait être retournée comme résultat de fonction dans l’eventualité d’une erreur. Sur certains systèmes, strerror() renvoie NULL si le numéro d’erreur est inconnu. Sur d’autres, strerror() renvoie une chaîne du style « Error nnn occurred » et écrit EINVAL dans errno si le numéro d’erreur est inconnu.

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

Ce document est une traduction réalisée par Christophe Blaess <http://www.blaess.fr/christophe/> le 9 novembre 1996 et révisée le 14 août 2006.

L’équipe de traduction a fait le maximum pour réaliser une adaptation française de qualité. La version anglaise la plus à jour de ce document est toujours consultable via la commande : « LANG=C man 3 strerror ». N’hésitez pas à signaler à l’auteur ou au traducteur, selon le cas, toute erreur dans cette page de manuel.