usr/src/man/man3head/dirent.h.3head

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  44 .\" Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
  45 .\"
  46 .TH DIRENT.H 3HEAD "Sep 10, 2004"
  47 .SH NAME
  48 dirent.h, dirent \- format of directory entries
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <\fBdirent.h\fR>
  53 .fi
  54
  55 .SH DESCRIPTION
  56 .sp
  57 .LP
  58 The internal format of directories is unspecified. The <\fBdirent.h\fR> header
  59 defines the following type:
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBDIR\fR\fR
  64 .ad
  65 .RS 7n
  66 A type representing a directory stream.
  67 .RE
  68
  69 .sp
  70 .LP
  71 The header also defines the structure \fBdirent\fR, which includes the
  72 following members:
  73 .sp
  74 .in +2
  75 .nf
  76 ino_t d_ino        /* file serial number */
  77 char  d_name[]     /* name of entry */
  78 .fi
  79 .in -2
  80
  81 .sp
  82 .LP
  83 The type \fBino_t\fR is defined as described in <\fBsys/types.h\fR>. See
  84 \fBtypes\fR(3HEAD).
  85 .sp
  86 .LP
  87 The character array \fBd_name\fR is of unspecified size, but the number of
  88 bytes preceding the terminating null byte must not exceed {\fBNAME_MAX\fR}.
  89 .SH ATTRIBUTES
  90 .sp
  91 .LP
  92 See \fBattributes\fR(5) for descriptions of the following attributes:
  93 .sp
  94
  95 .sp
  96 .TS
  97 box;
  98 c | c
  99 l | l .
 100 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 101 _
 102 Interface Stability     Standard
 103 .TE
 104
 105 .SH SEE ALSO
 106 .sp
 107 .LP
 108 \fBclosedir\fR(3C), \fBopendir\fR(3C), \fBreaddir\fR(3C), \fBrewinddir\fR(3C),
 109 \fBseekdir\fR(3C), \fBtelldir\fR(3C), \fBtypes.h\fR(3HEAD),
 110 \fBattributes\fR(5), \fBstandards\fR(5)