xref: /titanic_51/usr/src/man/man3head/glob.h.3head (revision 53089ab7c84db6fb76c16ca50076c147cda11757)
te
Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
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
http://www.opengroup.org/bookstore/.
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.
This notice shall appear on any product containing this material.
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.
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.
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]
GLOB.H 3HEAD "Sep 10, 2004"
NAME
glob.h, glob - pathname pattern-matching types
SYNOPSIS

#include <glob.h>
DESCRIPTION

The <glob.h> header defines the structures and symbolic constants used by the glob(3C).

The structure type glob_t contains the following members:

size_t gl_pathc /* count of paths matched by pattern */
char **gl_pathv /* pointer to a list of matched
 pathnames */
size_t gl_offs /* lots to reserve at the beginning
 of gl_pathv */

The following constants are provided as values for the flags argument: GLOB_APPEND

Append generated pathnames to those previously obtained.

GLOB_DOOFFS

Specify how many null pointers to add to the beginning of gl_pathv.

GLOB_ERR

Cause glob() to return on error.

GLOB_MARK

Each pathname that is a directory that matches pattern has a slash appended.

GLOB_NOCHECK

If pattern does not match any pathname, then return a list consisting of only pattern.

GLOB_NOESCAPE

Disable backslash escaping.

GLOB_NOSORT

Do not sort the pathnames returned.

The following constants are defined as error return values: GLOB_ABORTED

The scan was stopped because GLOB_ERR was set or (*errfunc)() returned non-zero.

GLOB_NOMATCH

The pattern does not match any existing pathname, and GLOB_NOCHECK was not set in flags.

GLOB_NOSPACE

An attempt to allocate memory failed.

GLOB_NOSYS

Reserved.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
SEE ALSO

glob(3C), attributes(5), standards(5)