1wordexp.h(3HEAD)                    Headers                   wordexp.h(3HEAD)
2
3
4

NAME

6       wordexp.h, wordexp - word-expansion types
7

SYNOPSIS

9       #include <wordexp.h>
10
11

DESCRIPTION

13       The  <wordexp.h>  header  defines the structures and symbolic constants
14       used by the wordexp() and wordfree() functions. See wordexp(3C).
15
16
17       The structure type wordexp_t contains the following members:
18
19         size_t we_wordc        /* count of words matched by words */
20         char   **we_wordv      /* pointer to list of expanded words */
21         size_t we_offs         /* slots to reserve at the beginning
22                                   of we_wordv */
23
24
25
26       The flags argument to the wordexp() function is  the  bitwise-inclusive
27       OR of the following flags:
28
29       WRDE_APPEND     Append words to those previously generated.
30
31
32       WRDE_DOOFFS     Number of null pointers to prepend to we_wordv.
33
34
35       WRDE_NOCMD      Fail if command substitution is requested.
36
37
38       WRDE_REUSE      The pwordexp argument was passed to a previous success‐
39                       ful call to wordexp(), and has not been passed to word‐
40                       free().  The  result  is the same as if the application
41                       had called wordfree() and then called wordexp() without
42                       WRDE_REUSE.
43
44
45       WRDE_SHOWERR    Do not redirect stderr to /dev/null.
46
47
48       WRDE_UNDEF      Report error on an attempt to expand an undefined shell
49                       variable.
50
51
52
53       The following constants are defined as error return values:
54
55       WRDE_BADCHAR    One of the  unquoted  characters—<newline>,  '|',  '&',
56                       ';',  '<',  '>', '(', ')', '{', '}'—appears in words in
57                       an inappropriate context.
58
59
60       WRDE_BADVAL     Reference to undefined shell variable  when  WRDE_UNDEF
61                       is set in flags.
62
63
64       WRDE_CMDSUB     Command  substitution requested when WRDE_NOCMD was set
65                       in flags.
66
67
68       WRDE_NOSPACE    Attempt to allocate memory failed.
69
70
71       WRDE_NOSYS      Reserved.
72
73
74       WRDE_SYNTAX     Shell syntax error, such as unbalanced  parentheses  or
75                       unterminated string.
76
77
78
79       The <wordexp.h> header defines the following type:
80
81       size_t    As described in <stddef.h>.
82
83

ATTRIBUTES

85       See attributes(5) for descriptions of the following attributes:
86
87
88
89
90       ┌─────────────────────────────┬─────────────────────────────┐
91       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
92       ├─────────────────────────────┼─────────────────────────────┤
93       │Interface Stability          │Standard                     │
94       └─────────────────────────────┴─────────────────────────────┘
95

SEE ALSO

97       wordexp(3C), attributes(5), standards(5)
98
99
100
101SunOS 5.11                        10 Sep 2004                 wordexp.h(3HEAD)
Impressum