logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

dirent.h.0p (4358B)

    

  1. '\" et
  2. .TH dirent.h "0P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. dirent.h
  12. \(em format of directory entries
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <dirent.h>
  17. .fi
  18. .SH DESCRIPTION
  19. The internal format of directories is unspecified.
  20. .P
  21. The
  22. .IR <dirent.h> 
  23. header shall define the following type:
  24. .IP "\fBDIR\fR" 8
  25. A type representing a directory stream. The
  26. .BR DIR
  27. type may be an incomplete type.
  28. .P
  29. It shall also define the structure
  30. .BR dirent
  31. which shall include the following members:
  32. .sp
  33. .RS 4
  34. .nf
  36. ino_t  d_ino       \fRFile serial number.\fR
  37. char   d_name[]    \fRFilename string of entry.\fR
  38. .fi
  39. .P
  40. .RE
  41. .P
  42. The
  43. .IR <dirent.h> 
  44. header shall define the
  45. .BR ino_t
  46. type as described in
  47. .IR <sys/types.h> .
  48. .P
  49. The array
  50. .IR d_name
  51. is of unspecified size, but shall contain a filename of at most
  52. {NAME_MAX}
  53. bytes followed by a terminating null byte.
  54. .P
  55. The following shall be declared as functions and may also be defined as
  56. macros. Function prototypes shall be provided.
  57. .sp
  58. .RS 4
  59. .nf
  61. int            alphasort(const struct dirent **, const struct dirent **);
  62. int            closedir(DIR *);
  63. int            dirfd(DIR *);
  64. DIR           *fdopendir(int);
  65. DIR           *opendir(const char *);
  66. struct dirent *readdir(DIR *);
  67. int            readdir_r(DIR *restrict, struct dirent *restrict,
  68.                    struct dirent **restrict);
  69. void           rewinddir(DIR *);
  70. int            scandir(const char *, struct dirent ***,
  71.                    int (*)(const struct dirent *),
  72.                    int (*)(const struct dirent **,
  73.                    const struct dirent **));
  74. void           seekdir(DIR *, long);
  75. long           telldir(DIR *);
  76. .fi
  77. .P
  78. .RE
  79. .LP
  80. .IR "The following sections are informative."
  81. .SH "APPLICATION USAGE"
  82. None.
  83. .SH RATIONALE
  84. Information similar to that in the
  85. .IR <dirent.h> 
  86. header is contained in a file
  87. .IR <sys/dir.h> 
  88. in 4.2 BSD and 4.3 BSD. The equivalent in these implementations of
  89. .BR "struct dirent"
  90. from this volume of POSIX.1\(hy2017 is
  91. .BR "struct direct" .
  92. The filename was changed because the name
  93. .IR <sys/dir.h> 
  94. was also used in earlier implementations to refer to definitions
  95. related to the older access method; this produced name conflicts. The
  96. name of the structure was changed because this volume of POSIX.1\(hy2017 does not completely
  97. define what is in the structure, so it could be different on some
  98. implementations from
  99. .BR "struct direct" .
  100. .P
  101. The name of an array of
  102. .BR char
  103. of an unspecified size should not be used as an lvalue. Use of:
  104. .sp
  105. .RS 4
  106. .nf
  108. sizeof(d_name)
  109. .fi
  110. .P
  111. .RE
  112. .P
  113. is incorrect; use:
  114. .sp
  115. .RS 4
  116. .nf
  118. strlen(d_name)
  119. .fi
  120. .P
  121. .RE
  122. .P
  123. instead.
  124. .P
  125. The array of
  126. .BR char
  127. .IR d_name
  128. is not a fixed size. Implementations may need to declare
  129. .BR "struct dirent"
  130. with an array size for
  131. .IR d_name
  132. of 1, but the actual number of bytes provided matches (or only slightly
  133. exceeds) the length of the filename string.
  134. .SH "FUTURE DIRECTIONS"
  135. None.
  136. .SH "SEE ALSO"
  137. .IR "\fB<sys_types.h>\fP"
  138. .P
  139. The System Interfaces volume of POSIX.1\(hy2017,
  140. .IR "\fIalphasort\fR\^(\|)",
  141. .IR "\fIclosedir\fR\^(\|)",
  142. .IR "\fIdirfd\fR\^(\|)",
  143. .IR "\fIfdopendir\fR\^(\|)",
  144. .IR "\fIreaddir\fR\^(\|)",
  145. .IR "\fIrewinddir\fR\^(\|)",
  146. .IR "\fIseekdir\fR\^(\|)",
  147. .IR "\fItelldir\fR\^(\|)"
  148. .\"
  149. .SH COPYRIGHT
  150. Portions of this text are reprinted and reproduced in electronic form
  151. from IEEE Std 1003.1-2017, Standard for Information Technology
  152. -- Portable Operating System Interface (POSIX), The Open Group Base
  153. Specifications Issue 7, 2018 Edition,
  154. Copyright (C) 2018 by the Institute of
  155. Electrical and Electronics Engineers, Inc and The Open Group.
  156. In the event of any discrepancy between this version and the original IEEE and
  157. The Open Group Standard, the original IEEE and The Open Group Standard
  158. is the referee document. The original Standard can be obtained online at
  159. http://www.opengroup.org/unix/online.html .
  160. .PP
  161. Any typographical or formatting errors that appear
  162. in this page are most likely
  163. to have been introduced during the conversion of the source files to
  164. man page format. To report such errors, see
  165. https://www.kernel.org/doc/man-pages/reporting_bugs.html .