.\" This manpage has been automatically generated by docbook2man
.\" from a DocBook document. This tool can be found at:
.\"
.\" Please send any bug reports, improvements, comments, patches,
.\" etc. to Steve Cheng .
.TH "CFG_SET_CONTEXT_FLAG" "3" "17 February 2004" "libcfg+ 0.6.2" "libcfg+ 0.6.2"
.SH NAME
cfg_set_context_flag, cfg_clear_context_flag, cfg_get_context_flag, cfg_set_context_flags, cfg_get_context_flags \- libcfg+ context flags manipulation functions
.SH "SYNOPSIS"
.PP
The following functions can be used to set various context flags:
.PP
.sp
\fB#include
.sp
void cfg_set_context_flag (const CFG_CONTEXT \fIcon\fB, int \fIflag\fB);
.sp
void cfg_clear_context_flag (const CFG_CONTEXT \fIcon\fB, int \fIflag\fB);
.sp
int cfg_get_context_flag (const CFG_CONTEXT \fIcon\fB, int \fIflag\fB);
.sp
void cfg_set_context_flags (const CFG_CONTEXT \fIcon\fB, int \fIflags\fB);
.sp
int cfg_get_context_flags (const CFG_CONTEXT \fIcon\fB, int \fIflags\fB);
\fR
.SH "DESCRIPTION"
.PP
You can set a context flag with \fBcfg_set_context_flag()\fR.
You can clear a flag with \fBcfg_clear_context_flag()\fR. To see
whether a flag is set, use \fBcfg_get_context_flag()\fR. It has
a macro alias \fBcfg_is_context_flag()\fR, which is identical
in every way.
.PP
The functions \fBcfg_set_context_flags()\fR and
\fBcfg_get_context_flags()\fR can set and retrieve the value of
all flags in one call.
.PP
A list of all settable context flags is provided in the following table.
.PP
"CONTEXT FLAGS"
.TP
\fBCFG_IGNORE_MULTI\fR
Ignore multiple arguments for a single option. The first argument will
be used to store the option value. The others are skipped.
By default, multiple arguments for an option that has not allowed
them, cause the CFG_ERROR_MULTI error.
.TP
\fBCFG_IGNORE_UNKNOWN\fR
Ignore all unknown options.
The default behaviour is to produce the
CFG_ERROR_UNKNOWN error when an unknown option is
encountered.
.TP
\fBCFG_SKIP_FIRST\fR
Setting this flag will cause the first argument on the command line to
be skipped. This flag affects only command line contexts.
The default behaviour is to parse all command line arguments.
.TP
\fBCFG_ADVANCED_LEFTOVERS\fR
Advanced leftover arguments. Setting this flag will drop the
requirement of the leftover arguments to conform to the
POSIX standard.
The default behaviour is to require the leftover arguments to conform
to POSIX. According to POSIX,
all option arguments must precede any non-option (leftover) arguments.
Once a non-option argument is found, all remaining arguments are also
interpreted as non-option.
.TP
\fBCFG_FILE_LINE_POS_USAGE\fR
Setting this flag will cause the parsing of configuration file to
become line- instead of byte-oriented. This will also change the
meaning of the values stored in \fIbegin_pos\fR and
\fIsize\fR.
By default, parsing is byte-oriented.
.PP
You can use the \fBcfg_clear_context_flag()\fR function to
restore the value of a flag to its default value.
.\" This is common footer for libcfg+ manpages.
.\" Written by Ondrej Jombik in 14th September 2002
.SH "SEE ALSO"
You can get library overview, table of contents and such additional information
info from main \fBlibcfg+\fR(3) manpage by typing "man libcfg+" on UNIX-based
systems. Also use this command to get information about authors, homepage and
license conditions.