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/.
7 .\" The Institute of Electrical and Electronics Engineers and The Open
8 .\" Group, have given us permission to reprint portions of their
11 .\" In the following statement, the phrase ``this text'' refers to portions
12 .\" of the system documentation.
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.
25 .\" This notice shall appear on any product containing this material.
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.
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.
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]
43 .\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved.
44 .\" Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
46 .TH GLOB.H 3HEAD "Sep 10, 2004"
48 glob.h, glob \- pathname pattern-matching types
52 #include <\fBglob.h\fR>
58 The <\fBglob.h\fR> header defines the structures and symbolic constants used by
62 The structure type \fBglob_t\fR contains the following members:
66 size_t gl_pathc /* count of paths matched by pattern */
67 char **gl_pathv /* pointer to a list of matched
69 size_t gl_offs /* lots to reserve at the beginning
76 The following constants are provided as values for the \fBflags\fR argument:
80 \fB\fBGLOB_APPEND\fR\fR
83 Append generated pathnames to those previously obtained.
89 \fB\fBGLOB_DOOFFS\fR\fR
92 Specify how many null pointers to add to the beginning of \fBgl_pathv\fR.
101 Cause \fBglob()\fR to return on error.
107 \fB\fBGLOB_MARK\fR\fR
110 Each pathname that is a directory that matches pattern has a slash appended.
116 \fB\fBGLOB_NOCHECK\fR\fR
119 If pattern does not match any pathname, then return a list consisting of only
126 \fB\fBGLOB_NOESCAPE\fR\fR
129 Disable backslash escaping.
135 \fB\fBGLOB_NOSORT\fR\fR
138 Do not sort the pathnames returned.
143 The following constants are defined as error return values:
147 \fB\fBGLOB_ABORTED\fR\fR
150 The scan was stopped because \fBGLOB_ERR\fR was set or \fB(*errfunc)()\fR
157 \fB\fBGLOB_NOMATCH\fR\fR
160 The pattern does not match any existing pathname, and \fBGLOB_NOCHECK\fR was
167 \fB\fBGLOB_NOSPACE\fR\fR
170 An attempt to allocate memory failed.
176 \fB\fBGLOB_NOSYS\fR\fR
185 See \fBattributes\fR(5) for descriptions of the following attributes:
193 ATTRIBUTE TYPE ATTRIBUTE VALUE
195 Interface Stability Standard
201 \fBglob\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)