readdir(3) Library Functions Manual readdir(3) NOM readdir - Consulter un repertoire BIBLIOTHEQUE Bibliotheque C standard (libc, -lc) SYNOPSIS #include struct dirent *readdir(DIR *dirp); DESCRIPTION La fonction readdir() renvoie un pointeur sur une structure dirent representant l'entree suivante du flux repertoire pointe par dirp. Elle renvoie NULL a la fin du repertoire ou en cas d'erreur. Dans l'implementation de la glibc, la structure dirent est definie comme suit : struct dirent { ino_t d_ino; /* numero d'inoeud */ 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 systeme de fichiers */ char d_name[256]; /* nom du fichier termine par l'octet NULL */ }; The only fields in the dirent structure that are mandated by POSIX.1 are d_name and d_ino. The other fields are unstandardized, and not present on all systems; see VERSIONS. Les champs de la structure dirent sont les suivants : d_ino Le numero d'inoeud du fichier. d_off La valeur renvoyee dans d_off est celle qui serait renvoyee en appelant telldir(3) a la position actuelle dans le flux repertoire. Soyez conscient que, malgre son type et son nom, le champ d_off ne represente que rarement une sorte de position de repertoire sur les systemes de fichiers modernes. Les applications devraient traiter ce champ comme une valeur opaque, sans faire de supposition sur son contenu. Consultez aussi telldir(3). d_reclen This is the size (in bytes) of the returned record. This may not match the size of the structure definition shown above; see VERSIONS. d_type Ce champ contient une valeur indiquant le type du fichier, permettant d'eviter le cout d'un appel a lstat(2) si d'autres actions dependent du type du fichier. Lorsqu'une macro de test de fonctionnalite est definie (_DEFAULT_SOURCE depuis la glibc 2.19, ou _BSD_SOURCE pour la glibc 2.19 ou anterieure), la glibc definit les constantes de macro suivantes pour les valeurs renvoyees dans d_type : DT_BLK Il s'agit d'un peripherique bloc. DT_CHR Il s'agit d'un peripherique caractere. DT_DIR Il s'agit d'un repertoire DT_FIFO Il s'agit d'un tube nomme (FIFO). DT_LNK Il s'agit d'un lien symbolique. DT_REG Il s'agit d'un fichier ordinaire. DT_SOCK Il s'agit d'un socket de domaine UNIX. DT_UNKNOWN Le type du fichier n'a pu etre determine. Actuellement, seuls certains systemes de fichiers (parmi lesquels Btrfs, ext2, ext3 et ext4) prennent completement en charge le renvoi du type de fichier dans d_type. Toutes les applications doivent gerer correctement une valeur de retour valant DT_UNKNOWN. d_name This field contains the null terminated filename; see VERSIONS. Les donnes renvoyees par readdir() sont ecrasees lors de l'appel suivant a readdir() sur le meme flux repertoire. VALEUR RENVOYEE En cas de succes, readdir() renvoie un pointeur sur une structure dirent (cette structure peut avoir ete allouee statiquement ; n'essayez pas de la desallouer avec free(3)). Lorsque la fin du flux repertoire est atteinte, NULL est renvoye et errno n'est pas modifiee. En cas d'erreur, NULL est renvoye et errno contient le code d'erreur. Pour distinguer la fin du flux d'une erreur, il faut assigner errno a zero avant d'appeler readdir() puis ensuite tester la valeur de errno si NULL est renvoye. ERREURS EBADF Le descripteur de flux repertoire dirp n'est pas valable. ATTRIBUTS Pour une explication des termes utilises dans cette section, consulter attributes(7). +----------------+--------------------------+--------------------------+ |Interface | Attribut | Valeur | +----------------+--------------------------+--------------------------+ |readdir() | Securite des threads | MT-Unsafe race:dirstream | +----------------+--------------------------+--------------------------+ Dans la specification POSIX.1 actuelle (POSIX.1-2008), il n'est pas requis que readdir(3) soit sur vis-a-vis des threads. Cependant, dans les implementations modernes, incluant la glibc, des appels concurrents a readdir(3) pour des flux repertoire differents sont surs vis-a-vis des threads. Dans le cas ou de multiples threads doivent lire depuis un flux de repertoire identique, l'utilisation de readdir(3) avec une synchronisation externe est toujours preferable a l'utilisation de readdir_r(3). Il est attendu qu'une future version de POSIX.1 demande que readdir() soit sur vis-a-vis des threads lorsqu'il est employe simultanement sur des flux repertoire differents. VERSIONS Seuls les champs d_name et (comme extension XSI) d_ino sont specifies dans POSIX.1. Ailleurs que sur Linux, le champ d_type est principalement disponible sur les systemes BSD. Les autres champs sont disponibles sur beaucoup de systemes, mais pas sur tous. Avec la glibc, les programmes peuvent verifier la disponibilite des champs non definis dans POSIX.1 en testant si les macros _DIRENT_HAVE_D_NAMLEN, _DIRENT_HAVE_D_RECLEN, _DIRENT_HAVE_D_OFF ou _DIRENT_HAVE_D_TYPE sont definies. Le champ d_name La definition de la structure dirent donne ci-dessus est reprise des en-tetes de la glibc et montre le champ d_name avec une taille fixe. Warning: applications should avoid any dependence on the size of the d_name field. POSIX defines it as char d_name[], a character array of unspecified size, with at most NAME_MAX characters preceding the terminating null byte ('\0'). POSIX.1 est explicite sur le fait que ce champ ne doit pas etre utilise comme une lvalue. La norme ajoute que l'utilisation de sizeof(d_name) est incorrecte ; utilisez strlen(d_name) a la place. Sur certains systemes, ce champ est defini comme char d_name[1] ! Cela implique que l'utilisation de sizeof(struct dirent) pour determiner la taille de l'enregistrement, y compris du champ d_name, est egalement incorrecte. Notez que bien que l'appel fpathconf(fd, _PC_NAME_MAX) renvoie la valeur 255 pour la plupart des systemes de fichiers, le nom de fichier termine par l'octet NULL qui est (correctement) renvoye dans d_name peut en fait depasser cette taille sur certains systemes de fichiers (CIFS ou les serveurs Windows SMB par exemple). Dans de tels cas, le champ d_reclen contiendra une valeur qui depasse la taille de la structure dirent de la glibc montree plus haut. STANDARDS POSIX.1-2008. HISTORIQUE POSIX.1-2001, SVr4, 4.3BSD. NOTES Un flux repertoire est ouvert avec opendir(3). L'ordre dans lequel les noms de fichier sont lus par des appels successifs a readdir() depend de l'implementation du systeme de fichiers ; il est peu probable que les noms soient tries d'une quelconque facon. VOIR AUSSI getdents(2), read(2), closedir(3), dirfd(3), ftw(3), offsetof(3), opendir(3), readdir_r(3), rewinddir(3), scandir(3), seekdir(3), telldir(3) TRADUCTION La traduction francaise de cette page de manuel a ete creee par Christophe Blaess , Stephan Rafin , Thierry Vignaud , Francois Micaux, Alain Portal , Jean-Philippe Guerard , Jean-Luc Coulon (f5ibh) , Julien Cristau , Thomas Huriaux , Nicolas Francois , Florentin Duneau , Simon Paillard , Denis Barbier , David Prevot , Frederic Hantrais et Gregoire Scano Cette traduction est une documentation libre ; veuillez vous reporter a la GNU General Public License version 3 concernant les conditions de copie et de distribution. Il n'y a aucune RESPONSABILITE LEGALE. Si vous decouvrez un bogue dans la traduction de cette page de manuel, veuillez envoyer un message a . Pages du manuel de Linux 6.9.1 16 juin 2024 readdir(3)