.\" -*- coding: UTF-8 -*- '\" t .\" Copyright (C) 1993 David Metcalfe (david@prism.demon.co.uk) .\" and Copyright (C) 2008, 2016 Michael Kerrisk .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" .\" References consulted: .\" Linux libc source code .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sat Jul 24 16:09:49 1993 by Rik Faith (faith@cs.unc.edu) .\" Modified 11 June 1995 by Andries Brouwer (aeb@cwi.nl) .\" Modified 22 July 1996 by Andries Brouwer (aeb@cwi.nl) .\" 2007-07-30 Ulrich Drepper , mtk: .\" Rework discussion of nonstandard structure fields. .\" .\"******************************************************************* .\" .\" This file was generated with po4a. Translate the source file. .\" .\"******************************************************************* .TH readdir 3 "5 février 2023" "Pages du manuel de Linux 6.03" .SH NOM readdir \- Consulter un répertoire .SH BIBLIOTHÈQUE Bibliothèque C standard (\fIlibc\fP, \fI\-lc\fP) .SH SYNOPSIS .nf \fB#include \fP .PP \fBstruct dirent *readdir(DIR *\fP\fIdirp\fP\fB);\fP .fi .SH DESCRIPTION La fonction \fBreaddir\fP() renvoie un pointeur sur une structure \fIdirent\fP représentant l'entrée suivante du flux répertoire pointé par \fIdirp\fP. Elle renvoie NULL à la fin du répertoire ou en cas d'erreur. .PP Dans l'implémentation de la glibc, la structure \fIdirent\fP est définie comme suit\ : .PP .in +4n .EX struct dirent { ino_t d_ino; /* numéro d'inœud */ off_t d_off; /* pas une position ; consultez NOTES */ unsigned short d_reclen; /* longueur de cet enregistrement */ unsigned char d_type; /* type du fichier ; pas pris en charge par tous les types de système de fichiers */ char d_name[256]; /* nom du fichier terminé par l'octet NULL */ }; .EE .in .PP Les seuls champs exigés par POSIX.1 pour la structure \fIdirent\fP sont \fId_name\fP et \fId_ino\fP. Les autres champs ne sont pas normalisés et ne sont pas présents sur tous les systèmes\ ; consultez les \fBNOTES\fP ci\-dessous pour plus de détails. .PP Les champs de la structure \fIdirent\fP sont les suivants\ : .TP \fId_ino\fP Le numéro d'inode du fichier. .TP \fId_off\fP .\" https://lwn.net/Articles/544298/ La valeur renvoyée dans \fId_off\fP est celle qui serait renvoyée en appelant \fBtelldir\fP(3) à la position actuelle dans le flux répertoire. Soyez conscient que, malgré son type et son nom, le champ \fId_off\fP ne représente que rarement une sorte de position de répertoire sur les systèmes de fichiers modernes. Les applications devraient traiter ce champ comme une valeur opaque, sans faire de supposition sur son contenu. Consultez aussi \fBtelldir\fP(3). .TP \fId_reclen\fP La taille (en octets) de l'enregistrement renvoyé. Elle peut ne pas correspondre à la taille de la définition de la structure montrée plus haut\ ; voir NOTES. .TP \fId_type\fP Ce champ contient une valeur indiquant le type du fichier, permettant d'éviter le coût d'un appel à \fBlstat\fP(2) si d'autres actions dépendent du type du fichier. .IP Lorsqu'une macro de test de fonctionnalité est définie (\fB_DEFAULT_SOURCE\fP depuis la glibc\ 2.19, ou \fB_BSD_SOURCE\fP pour la glibc\ 2.19 ou antérieure), la glibc définit les constantes de macro suivantes pour les valeurs renvoyées dans \fId_type\fP\ : .RS .TP 12 \fBDT_BLK\fP Il s'agit d'un périphérique bloc. .TP \fBDT_CHR\fP Il s'agit d'un périphérique caractère. .TP \fBDT_DIR\fP Il s'agit d'un répertoire .TP \fBDT_FIFO\fP Il s'agit d'un tube nommé (FIFO). .TP \fBDT_LNK\fP Il s'agit d'un lien symbolique. .TP \fBDT_REG\fP Il s'agit d'un fichier ordinaire. .TP \fBDT_SOCK\fP Il s'agit d'un socket de domaine UNIX. .TP \fBDT_UNKNOWN\fP Le type du fichier n'a pu être déterminé. .RE .IP .\" kernel 2.6.27 .\" The same sentence is in getdents.2 Actuellement, seuls certains systèmes de fichiers (parmi lesquels Btrfs, ext2, ext3 et ext4) prennent complètement en charge le renvoi du type de fichier dans \fId_type\fP. Toutes les applications doivent gérer correctement une valeur de retour valant \fBDT_UNKNOWN\fP. .TP \fId_name\fP Ce champ contient le nom de fichier terminé par l'octet NULL. \fIVoir NOTES\fP. .PP Les données renvoyées par \fBreaddir\fP() sont écrasées lors de l'appel suivant à \fBreaddir\fP() sur le même flux répertoire. .SH "VALEUR RENVOYÉE" En cas de succès, \fBreaddir\fP() renvoie un pointeur sur une structure \fIdirent\fP (cette structure peut avoir été allouée statiquement\ ; n'essayez pas de la désallouer avec \fBfree\fP(3)). .PP Lorsque la fin du flux répertoire est atteinte, NULL est renvoyé et \fIerrno\fP n'est pas modifiée. En cas d'erreur, NULL est renvoyée et \fIerrno\fP contient le code d'erreur. Pour distinguer la fin du flux d'une erreur, il faut assigner \fIerrno\fP à zéro avant d'appeler \fBreaddir()\fP puis ensuite tester la valeur de \fIerrno\fP si NULL est renvoyé. .SH ERREURS .TP \fBEBADF\fP Le descripteur de flux répertoire \fIdirp\fP n'est pas valable. .SH ATTRIBUTS Pour une explication des termes utilisés dans cette section, consulter \fBattributes\fP(7). .ad l .nh .TS allbox; lbx lb lb l l l. Interface Attribut Valeur T{ \fBreaddir\fP() T} Sécurité des threads MT\-Unsafe race:dirstream .TE .hy .ad .sp 1 .PP .\" FIXME . .\" http://www.austingroupbugs.net/view.php?id=696 Dans la spécification POSIX.1 courante (POSIX.1\-2008), il n'est pas requis que \fBreaddir\fP(3) soit sûr vis\-à\-vis des threads. Cependant, dans les implémentations modernes, incluant la glibc, des appels concurrents à \fBreaddir\fP(3) pour des flux répertoire différents sont sûrs vis\-à\-vis des threads. Dans le cas où de multiples threads doivent lire depuis un flux de répertoire identique, l'utilisation de \fBreaddir\fP(3) avec une synchronisation externe est toujours préférable à l'utilisation de \fBreaddir_r\fP(3). Il est attendu qu’une future version de POSIX.1 demande que \fBreaddir\fP() soit sûr vis\-à\-vis des threads lorsqu’il est employé simultanément sur des flux répertoire différents. .SH STANDARDS POSIX.1\-2001, POSIX.1\-2008, SVr4, 4.3BSD. .SH NOTES Un flux répertoire est ouvert avec \fBopendir\fP(3). .PP L'ordre dans lequel les noms de fichier sont lus par des appels successifs à \fBreaddir\fP() dépend de l'implémentation du système de fichiers\ ; il est peu probable que les noms soient triés d'une quelconque façon. .PP .\" POSIX.1-2001, POSIX.1-2008 .\" Seuls les champs \fId_name\fP et (comme extension XSI) \fId_ino\fP sont spécifiés dans POSIX.1. Ailleurs que sur Linux, le champ \fId_type\fP est principalement disponible sur les systèmes BSD. Les autres champs sont disponibles sur beaucoup de systèmes, mais pas sur tous. Avec la glibc, les programmes peuvent vérifier la disponibilité des champs non définis dans POSIX.1 en testant si les macros \fB_DIRENT_HAVE_D_NAMLEN\fP, \fB_DIRENT_HAVE_D_RECLEN\fP, \fB_DIRENT_HAVE_D_OFF\fP ou \fB_DIRENT_HAVE_D_TYPE\fP sont définies. .SS "Le champ d_name" La définition de la structure \fIdirent\fP donnée ci\-dessus est reprise des en\-têtes de la glibc et montre le champ \fId_name\fP avec une taille fixe. .PP \fIAvertissement\fP\ : les applications devraient éviter tout dépendance sur la taille du champ \fId_name\fP. POSIX la définit comme \fIchar\ d_name[]\fP, un tableau de caractères de taille non spécifiée, avec au plus \fBNAME_MAX\fP caractères avant l'octet NULL final (\[aq]\e0\[aq]). .PP POSIX.1 est explicite sur le fait que ce champ ne doit pas être utilisé comme une lvalue. La norme ajoute que l'utilisation de \fIsizeof(d_name)\fP est incorrecte\ ; utilisez \fIstrlen(d_name)\fP à la place. Sur certains systèmes, ce champ est défini comme \fIchar\~d_name[1]\fP\ ! Cela implique que l'utilisation de \fIsizeof(struct dirent)\fP pour déterminer la taille de l'enregistrement, y compris du champ \fId_name\fP, est également incorrecte. .PP Notez que bien que l'appel .PP .in +4n .EX fpathconf(fd, _PC_NAME_MAX) .EE .in .PP renvoie la valeur 255 pour la plupart des systèmes de fichiers, le nom de fichier terminé par l'octet NULL qui est (correctement) renvoyé dans \fId_name\fP peut en fait dépasser cette taille sur certains systèmes de fichiers (CIFS ou les serveurs Windows SMB par exemple). Dans de tels cas, le champ \fId_reclen\fP contiendra une valeur qui dépasse la taille de la structure \fIdirent\fP de la glibc montrée plus haut. .SH "VOIR AUSSI" \fBgetdents\fP(2), \fBread\fP(2), \fBclosedir\fP(3), \fBdirfd\fP(3), \fBftw\fP(3), \fBoffsetof\fP(3), \fBopendir\fP(3), \fBreaddir_r\fP(3), \fBrewinddir\fP(3), \fBscandir\fP(3), \fBseekdir\fP(3), \fBtelldir\fP(3) .PP .SH TRADUCTION La traduction française de cette page de manuel a été créée par Christophe Blaess , Stéphan Rafin , Thierry Vignaud , François Micaux, Alain Portal , Jean-Philippe Guérard , Jean-Luc Coulon (f5ibh) , Julien Cristau , Thomas Huriaux , Nicolas François , Florentin Duneau , Simon Paillard , Denis Barbier , David Prévot et Grégoire Scano . .PP Cette traduction est une documentation libre ; veuillez vous reporter à la .UR https://www.gnu.org/licenses/gpl-3.0.html GNU General Public License version 3 .UE concernant les conditions de copie et de distribution. Il n'y a aucune RESPONSABILITÉ LÉGALE. .PP Si vous découvrez un bogue dans la traduction de cette page de manuel, veuillez envoyer un message à .MT debian-l10n-french@lists.debian.org .ME .