| version 1.1, 2002/05/10 00:38:18 |
version 1.2, 2002/05/11 14:46:24 |
|
|
| <title id="usage.context-flags.title">Context flags</title> |
<title id="usage.context-flags.title">Context flags</title> |
| <para> |
<para> |
| |
|
| For setting various ... |
For setting particular context flages there are these functions: |
| |
|
| </para> |
</para> |
| <para> |
<para> |
| Line 23 For setting various ... |
|
| Line 23 For setting various ... |
|
| <paramdef>int <parameter>flag</parameter></paramdef> |
<paramdef>int <parameter>flag</parameter></paramdef> |
| </funcprototype> |
</funcprototype> |
| <funcprototype> |
<funcprototype> |
| <funcdef>void <function>cfg_get_context_flag</function></funcdef> |
<funcdef>int <function>cfg_get_context_flag</function></funcdef> |
| |
<paramdef>const CFG_CONTEXT <parameter>con</parameter></paramdef> |
| |
<paramdef>int <parameter>flag</parameter></paramdef> |
| |
</funcprototype> |
| |
<funcprototype> |
| |
<funcdef>int <function>cfg_is_context_flag</function></funcdef> |
| <paramdef>const CFG_CONTEXT <parameter>con</parameter></paramdef> |
<paramdef>const CFG_CONTEXT <parameter>con</parameter></paramdef> |
| <paramdef>int <parameter>flag</parameter></paramdef> |
<paramdef>int <parameter>flag</parameter></paramdef> |
| </funcprototype> |
</funcprototype> |
| Line 33 For setting various ... |
|
| Line 38 For setting various ... |
|
| <paramdef>int <parameter>flags</parameter></paramdef> |
<paramdef>int <parameter>flags</parameter></paramdef> |
| </funcprototype> |
</funcprototype> |
| <funcprototype> |
<funcprototype> |
| <funcdef>void <function>cfg_get_context_flags</function></funcdef> |
<funcdef>int <function>cfg_get_context_flags</function></funcdef> |
| <paramdef>const CFG_CONTEXT <parameter>con</parameter></paramdef> |
<paramdef>const CFG_CONTEXT <parameter>con</parameter></paramdef> |
| <paramdef>int <parameter>flags</parameter></paramdef> |
<paramdef>int <parameter>flags</parameter></paramdef> |
| </funcprototype> |
</funcprototype> |
| Line 43 For setting various ... |
|
| Line 48 For setting various ... |
|
| </para> |
</para> |
| <para> |
<para> |
| |
|
| #define cfg_is_context_flag(con, flag) cfg_get_context_flag(con, flag) |
These functions and macros manipulate with context flags. The function |
| |
<function>cfg_set_context_flag()</function> sets one particular context flag. |
| |
Similary, function <function>cfg_clear_context_flag()</function> clears one |
| |
context flags. Functions <function>cfg_get_context_flag()</function> and its |
| |
macro alias <function>cfg_is_context_flag()</function> which is indentical in |
| |
every way, detect if particular context flag is set. |
| |
|
| |
</para> |
| |
<para> |
| |
|
| |
Remaining two functions <function>cfg_set_context_flags()</function> and |
| |
<function>cfg_get_context_flags()</function> can set and get all flags in one |
| |
call. Note that when you set flags with |
| |
<function>cfg_set_context_flags()</function> current flag state of context is |
| |
overwritten by <parameter>flags</parameter> parameter passed to this function. |
| |
|
| |
</para> |
| |
<para> |
| |
|
| |
List of setable context flags described in following table. |
| |
|
| |
</para> |
| |
<para> |
| |
|
| |
<table id="usage.context-flags.table" frame=top> |
| |
<title id="usage.context-flags.table.title">Context flags</title> |
| |
<tgroup cols=2> |
| |
<thead> |
| |
<row> |
| |
<entry>Flag</entry> |
| |
<!-- <entry><structfield>value</structfield> type</entry> --> |
| |
<entry>Description</entry> |
| |
</row> |
| |
</thead> |
| |
<tbody> |
| |
<row> |
| |
<entry><constant>CFG_IGNORE_MULTI</constant></entry> |
| |
<entry>Ignore multiple arguments for single option.</entry> |
| |
</row> |
| |
<row> |
| |
<entry><constant>CFG_IGNORE_UNKNOWN</constant></entry> |
| |
<entry>Ignore unknown options.</entry> |
| |
</row> |
| |
<row> |
| |
<entry><constant>CFG_PROCESS_FIRST</constant></entry> |
| |
<entry>Process also the first argument on command line.</entry> |
| |
</row> |
| |
<row> |
| |
<entry><constant>CFG_ADVANCED_LEFTOVERS</constant></entry> |
| |
<entry>Advanced leftover arguments.</entry> |
| |
</row> |
| |
<row> |
| |
<entry><constant>CFG_STRICT_LEFTOVERS</constant></entry> |
| |
<entry>Strict leftover arguments initialization in file.</entry> |
| |
</row> |
| |
<row> |
| |
<entry><constant>CFG_FILE_LINE_POS_USAGE</constant></entry> |
| |
<entry>Line type position usage in file.</entry> |
| |
</row> |
| |
</tbody> |
| |
</tgroup> |
| |
</table> |
| |
</para> |
| |
|
| |
<para> |
| |
|
| |
Constants <constant>CFG_SKIP_FIRST</constant> (Skip processing of the first |
| |
argument on command line.), <constant>CFG_POSIXLY_LEFTOVERS</constant> (Posixly |
| |
correct leftover arguments.), <constant>CFG_NORMAL_LEFTOVERS</constant> (Normal |
| |
leftover arguments initialization in file.) and |
| |
<constant>CFG_FILE_BYTE_POS_USAGE</constant> (Byte type position usage in file.) |
| |
are set by default. Note that these constants contain real values of |
| |
<constant>0</constant>, thus they cannot be set. Instead of that, clear |
| |
appropriate opposite equivalent described in <xref |
| |
linkend="usage.context-flags.table" endterm="usage.context-flags.table.title"> |
| |
table to get result. |
| |
|
| </para> |
</para> |
| </sect1> |
</sect1> |
| |
|