NAME

wordexp.h - word-expansion types

 SYNOPSIS

#include <wordexp.h>

 DESCRIPTION

The <wordexp.h> header defines the structures and symbolic constants used by the wordexp() and wordfree() functions.

The structure type wordexp_t contains at least the following members:

size_t   we_wordc  count of words matched by words
char   **we_wordv  pointer to list of expanded words 
size_t   we_offs   slots to reserve at the beginning of we_wordv

The flags argument to the wordexp() function is the bitwise inclusive OR of the following flags:

WRDE_APPEND

Append words to those previously generated.

WRDE_DOOFFS

Number of null pointers to prepend to we_wordv.

WRDE_NOCMD

Fail if command substitution is requested.

WRDE_REUSE

The pwordexp argument was passed to a previous successful call to wordexp(), and has not been passed to wordfree(). The result will be the same as if the application had called wordfree() and then called wordexp() without WRDE_REUSE.

WRDE_SHOWERR

Do not redirect stderr to

WRDE_UNDEF

Report error on an attempt to expand an undefined shell variable.

The following constants are defined as error return values:

WRDE_BADCHAR

One of the unquoted characters:

<newline>   |   &   ;   <   >   (   )   {   }

appears in words in an inappropriate context.

WRDE_BADVAL

Reference to undefined shell variable when WRDE_UNDEF is set in flags.

WRDE_CMDSUB

Command substitution requested when WRDE_NOCMD was set in flags.

WRDE_NOSPACE

Attempt to allocate memory failed.

WRDE_NOSYS

The implementation does not support the function.

WRDE_SYNTAX

Shell syntax error, such as unbalanced parentheses or unterminated string.

The following are declared as functions and may also be declared as macros. Function prototypes must be provided for use with an ISO C compiler.

int  wordexp(const char *, wordexp_t *, int);
void wordfree(wordexp_t *);

The implementation may define additional macros or constants using names beginning with WRDE_.

 APPLICATION USAGE

None.

 FUTURE DIRECTIONS

None.

 SEE ALSO

wordexp(), the XCU specification.