HP-UX Reference (11i v3 07/02) - 3 Library Functions N-Z (vol 7)

ManualsBrandsHP ManualsSoftwareHP-UX Reference Manuals

661

662

663

664

665

666

667

668

669

670

wordexp(3C) wordexp(3C)

• Zero or more null pointers, as speciﬁed by

WRDE_DOOFFS and pwordexp->we_offs .

• Pointers to the words that were in the

pwordexp->we_wordv list before the call, in the

same order as before.

• Pointers to the new words generated by the latest call, in the speciﬁed order.

• The count returned in

pwordexp->we_wordc

is the total number of words from all of the calls.

• The application can change any of the ﬁelds after a call to

wordexp(), but if it does, it must

reset them to the original value before a subsequent call, using the same pwordexp value, to

wordfree() or wordexp() with the WRDE_APPEND or WRDE_REUSE

ﬂag.

If words contains an unquoted newline,

&, ;, <, >, parentheses, or curly brackets in an inappropriate

context,

wordexp() fails, and the number of expanded words is zero.

Unless WRDE_SHOWERR is set in ﬂags,

wordexp() redirects stderr to /dev/null for any utilities exe-

cuted as a result of command substitution while expanding words.If

WRDE_SHOWERR is set, wor-

dexp()

writes messages to stderr if syntax errors are detected while expanding words.

WRDE_DOOFFS is set, pwordexp->we_offs

has the same value for each wordexp() call and the

wordfree() call using a given wordexp().

RETURN VALUE

Upon successful completion, wordexp() returns zero; otherwise, it returns a nonzero value deﬁned in

<wordexp.h> to indicate the error:

WRDE_BADCHAR One of the unquoted characters |, &, ;, <, >, parentheses, or braces appears in

words in an inappropriate context.

WRDE_BADVAL Reference to undeﬁned shell variable when WRDE_UNDEF is set in ﬂags.

WRDE_CMDSUB Command substitution requested when WRDE_NOCMD was set in ﬂags.

WRDE_NOSPACE Attempt to allocate memory failed.

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

WRDE_INTERNAL Internal error.

If wordexp() returns the error value WRDE_NOSPACE , pwordexp->we_wordc and

pwordexp->we_wordv are updated to reﬂect any words that were successfully expanded. In other

cases, they are not modiﬁed.

AUTHOR

wordexp() and wordfree() were developed by OSF and HP.