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

   1 '\" te
   2 .\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH GLOB.H 3HEAD "Sep 10, 2004"
  11 .SH NAME
  12 glob.h, glob \- pathname pattern-matching types
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <\fBglob.h\fR>
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The <\fBglob.h\fR> header defines the structures and symbolic constants used by
  23 the \fBglob\fR(3C).
  24 .sp
  25 .LP
  26 The structure type \fBglob_t\fR contains the following members:
  27 .sp
  28 .in +2
  29 .nf
  30 size_t gl_pathc       /* count of paths matched by pattern */
  31 char   **gl_pathv     /* pointer to a list of matched
  32                          pathnames */
  33 size_t gl_offs        /* lots to reserve at the beginning
  34                          of gl_pathv */
  35 .fi
  36 .in -2
  37
  38 .sp
  39 .LP
  40 The following constants are provided as values for the \fBflags\fR argument:
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fBGLOB_APPEND\fR\fR
  45 .ad
  46 .RS 17n
  47 Append generated pathnames to those previously obtained.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBGLOB_DOOFFS\fR\fR
  54 .ad
  55 .RS 17n
  56 Specify how many null pointers to add to the beginning of \fBgl_pathv\fR.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBGLOB_ERR\fR\fR
  63 .ad
  64 .RS 17n
  65 Cause \fBglob()\fR to return on error.
  66 .RE
  67
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fBGLOB_MARK\fR\fR
  72 .ad
  73 .RS 17n
  74 Each pathname that is a directory that matches pattern has a slash appended.
  75 .RE
  76
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fBGLOB_NOCHECK\fR\fR
  81 .ad
  82 .RS 17n
  83 If pattern does not match any  pathname, then return a list consisting of only
  84 pattern.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fBGLOB_NOESCAPE\fR\fR
  91 .ad
  92 .RS 17n
  93 Disable backslash escaping.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fBGLOB_NOSORT\fR\fR
 100 .ad
 101 .RS 17n
 102 Do not sort the pathnames returned.
 103 .RE
 104
 105 .sp
 106 .LP
 107 The following constants are defined as error return values:
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fBGLOB_ABORTED\fR\fR
 112 .ad
 113 .RS 16n
 114 The scan was stopped because \fBGLOB_ERR\fR was set or \fB(*errfunc)()\fR
 115 returned non-zero.
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fBGLOB_NOMATCH\fR\fR
 122 .ad
 123 .RS 16n
 124 The pattern does not match any existing pathname, and \fBGLOB_NOCHECK\fR was
 125 not set in flags.
 126 .RE
 127
 128 .sp
 129 .ne 2
 130 .na
 131 \fB\fBGLOB_NOSPACE\fR\fR
 132 .ad
 133 .RS 16n
 134 An attempt to allocate memory failed.
 135 .RE
 136
 137 .sp
 138 .ne 2
 139 .na
 140 \fB\fBGLOB_NOSYS\fR\fR
 141 .ad
 142 .RS 16n
 143 Reserved.
 144 .RE
 145
 146 .SH ATTRIBUTES
 147 .sp
 148 .LP
 149 See \fBattributes\fR(5) for descriptions of the following attributes:
 150 .sp
 151
 152 .sp
 153 .TS
 154 box;
 155 c | c
 156 l | l .
 157 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 158 _
 159 Interface Stability     Standard
 160 .TE
 161
 162 .SH SEE ALSO
 163 .sp
 164 .LP
 165 \fBglob\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)