usr/src/man/man3head/glob.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 GLOB.H 3HEAD "Sep 10, 2004"
  47 .SH NAME
  48 glob.h, glob \- pathname pattern-matching types
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <\fBglob.h\fR>
  53 .fi
  54
  55 .SH DESCRIPTION
  56 .sp
  57 .LP
  58 The <\fBglob.h\fR> header defines the structures and symbolic constants used by
  59 the \fBglob\fR(3C).
  60 .sp
  61 .LP
  62 The structure type \fBglob_t\fR contains the following members:
  63 .sp
  64 .in +2
  65 .nf
  66 size_t gl_pathc       /* count of paths matched by pattern */
  67 char   **gl_pathv     /* pointer to a list of matched
  68                          pathnames */
  69 size_t gl_offs        /* lots to reserve at the beginning
  70                          of gl_pathv */
  71 .fi
  72 .in -2
  73
  74 .sp
  75 .LP
  76 The following constants are provided as values for the \fBflags\fR argument:
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fBGLOB_APPEND\fR\fR
  81 .ad
  82 .RS 17n
  83 Append generated pathnames to those previously obtained.
  84 .RE
  85
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fBGLOB_DOOFFS\fR\fR
  90 .ad
  91 .RS 17n
  92 Specify how many null pointers to add to the beginning of \fBgl_pathv\fR.
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fBGLOB_ERR\fR\fR
  99 .ad
 100 .RS 17n
 101 Cause \fBglob()\fR to return on error.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fBGLOB_MARK\fR\fR
 108 .ad
 109 .RS 17n
 110 Each pathname that is a directory that matches pattern has a slash appended.
 111 .RE
 112
 113 .sp
 114 .ne 2
 115 .na
 116 \fB\fBGLOB_NOCHECK\fR\fR
 117 .ad
 118 .RS 17n
 119 If pattern does not match any  pathname, then return a list consisting of only
 120 pattern.
 121 .RE
 122
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fBGLOB_NOESCAPE\fR\fR
 127 .ad
 128 .RS 17n
 129 Disable backslash escaping.
 130 .RE
 131
 132 .sp
 133 .ne 2
 134 .na
 135 \fB\fBGLOB_NOSORT\fR\fR
 136 .ad
 137 .RS 17n
 138 Do not sort the pathnames returned.
 139 .RE
 140
 141 .sp
 142 .LP
 143 The following constants are defined as error return values:
 144 .sp
 145 .ne 2
 146 .na
 147 \fB\fBGLOB_ABORTED\fR\fR
 148 .ad
 149 .RS 16n
 150 The scan was stopped because \fBGLOB_ERR\fR was set or \fB(*errfunc)()\fR
 151 returned non-zero.
 152 .RE
 153
 154 .sp
 155 .ne 2
 156 .na
 157 \fB\fBGLOB_NOMATCH\fR\fR
 158 .ad
 159 .RS 16n
 160 The pattern does not match any existing pathname, and \fBGLOB_NOCHECK\fR was
 161 not set in flags.
 162 .RE
 163
 164 .sp
 165 .ne 2
 166 .na
 167 \fB\fBGLOB_NOSPACE\fR\fR
 168 .ad
 169 .RS 16n
 170 An attempt to allocate memory failed.
 171 .RE
 172
 173 .sp
 174 .ne 2
 175 .na
 176 \fB\fBGLOB_NOSYS\fR\fR
 177 .ad
 178 .RS 16n
 179 Reserved.
 180 .RE
 181
 182 .SH ATTRIBUTES
 183 .sp
 184 .LP
 185 See \fBattributes\fR(5) for descriptions of the following attributes:
 186 .sp
 187
 188 .sp
 189 .TS
 190 box;
 191 c | c
 192 l | l .
 193 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 194 _
 195 Interface Stability     Standard
 196 .TE
 197
 198 .SH SEE ALSO
 199 .sp
 200 .LP
 201 \fBglob\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)