Opensource.Platon.SK CVS: libcfg+/doc/sgml/usage.properties.sgml - diff

Vyššie na [Platon] / libcfg+ / doc / sgml

Rozdiely pre libcfg+/doc/sgml/usage.properties.sgml medzi verziami 1.3 a 1.4

verzia 1.3, 2002/09/02 15:01:06

verzia 1.4, 2002/09/03 20:11:16

Riadok 23

<title id="usage.properties.title">Properties</title>

<para>

In this chapter are functions for manipulating with &name; properties

In this chapter are functions for manipulating with &name; properties described.

described.

We are starting with functions manipulating with one property. These functions

work also with virtual properties as well.

</para>

<para>

Riadok 61 Imagine one property as set of strings.

Riadok 62 Imagine one property as set of strings.

<function>cfg_clear_property()</function> clears all strings of property

specified by <parameter>type</parameter> parameter in context

<parameter>con</parameter>. Similary, function

<function>cfg_add_property()</function> adds string <parameter>str</parameter>

<function>cfg_add_property()</function> adds one string

to property specified by <parameter>type</parameter> parameter in context

<parameter>str</parameter> to property specified by <parameter>type</parameter>

<parameter>con</parameter>. Behaviour of

parameter in context <parameter>con</parameter>. Behaviour of

<function>cfg_remove_property()</function> is analogical. It removes one string

from property. All these functions return <constant>1</constant> on success or

<constant>0</constant> on not enough memory error.

Riadok 74 from property. All these functions retur

Riadok 75 from property. All these functions retur

Note that, when you set some string of multi vals separator property, any

whitespace you will use in that string will match any non-zero amount of

whitespaces during parsing. For example if separator is one space, also tab will

match, two spaces, tab will space and so forth.

match, two or more spaces too, tab with space and so forth. It is similar

behaviour like when option name contains one or more white characters.

</para>

<para>

Riadok 110 properties</title>

Riadok 112 properties</title>

</row>

</thead>

<tbody>

<row>

<entry>CFG_LINE_QUOTE_PREFIX</entry>

<entry><constant id="CFG_LINE_QUOTE_PREFIX.const">CFG_LINE_QUOTE_PREFIX</constant></entry>

<entry>command line quotation prefix</entry>

<entry>

Riadok 126 by appropriate <function>cfg_add_propert

Riadok 128 by appropriate <function>cfg_add_propert

</entry>

</row>

<row>

<entry>CFG_LINE_QUOTE_POSTFIX</entry>

<entry><constant id="CFG_LINE_QUOTE_POSTFIX.const">CFG_LINE_QUOTE_POSTFIX</constant></entry>

<entry>command line quotation postfix</entry>

<entry>

Riadok 138 is of course also nothing initialized du

Riadok 140 is of course also nothing initialized du

</entry>

</row>

<row>

<entry>CFG_LINE_STOP_STRING</entry>

<entry><constant id="CFG_LINE_STOP_STRING.const">CFG_LINE_STOP_STRING</constant></entry>

<entry>command line stop string</entry>

<entry>

Riadok 150 function to determine this event. By def

Riadok 152 function to determine this event. By def

</entry>

</row>

<row>

<entry>CFG_LINE_SHORT_OPTION_PREFIX</entry>

<entry><constant id="CFG_LINE_SHORT_OPTION_PREFIX.const">CFG_LINE_SHORT_OPTION_PREFIX</constant></entry>

<entry>command line short option prefix</entry>

<entry>

Riadok 161 used in applications. You will probably

Riadok 163 used in applications. You will probably

</entry>

</row>

<row>

<entry>CFG_LINE_LONG_OPTION_PREFIX</entry>

<entry><constant id="CFG_LINE_LONG_OPTION_PREFIX.const">CFG_LINE_LONG_OPTION_PREFIX</constant></entry>

<entry>command line short option prefix</entry>

<entry>

Riadok 172 used in applications. You will probably

Riadok 174 used in applications. You will probably

</entry>

</row>

<row>

<entry>CFG_LINE_NORMAL_MULTI_VALS_SEPARATOR</entry>

<entry><constant id="CFG_LINE_NORMAL_MULTI_VALS_SEPARATOR.const">CFG_LINE_NORMAL_MULTI_VALS_SEPARATOR</constant></entry>

<entry>normal command line multi values separator</entry>

<entry>

Riadok 186 comma (<constant>,</constant>) and semic

Riadok 188 comma (<constant>,</constant>) and semic

</entry>

</row>

<row>

<entry>CFG_LINE_LEFTOVER_MULTI_VALS_SEPARATOR</entry>

<entry><constant id="CFG_LINE_LEFTOVER_MULTI_VALS_SEPARATOR.const">CFG_LINE_LEFTOVER_MULTI_VALS_SEPARATOR</constant></entry>

<entry>leftover command line multi values separator</entry>

<entry>

Riadok 199 type). By default is nothing initialized

Riadok 201 type). By default is nothing initialized

</entry>

</row>

<row>

<entry>CFG_LINE_OPTION_ARG_SEPARATOR</entry>

<entry><constant id="CFG_LINE_OPTION_ARG_SEPARATOR.const">CFG_LINE_OPTION_ARG_SEPARATOR</constant></entry>

<entry>command line option argument separator</entry>

<entry>

Riadok 234 properties</title>

Riadok 236 properties</title>

</row>

</thead>

<tbody>

<row>

<entry>CFG_FILE_QUOTE_PREFIX</entry>

<entry><constant id="CFG_FILE_QUOTE_PREFIX.const">CFG_FILE_QUOTE_PREFIX</constant></entry>

<entry>configuration file quotation prefix</entry>

<entry>

Riadok 246 inverted commans (<constant>"</constant>

Riadok 248 inverted commans (<constant>"</constant>

</entry>

</row>

<row>

<entry>CFG_FILE_QUOTE_POSTFIX</entry>

<entry><constant id="CFG_FILE_QUOTE_POSTFIX.const">CFG_FILE_QUOTE_POSTFIX</constant></entry>

<entry>configuration file quotation postfix</entry>

<entry>

Riadok 258 inverted commans (<constant>"</constant>

Riadok 260 inverted commans (<constant>"</constant>

</entry>

</row>

<row>

<entry>CFG_FILE_STOP_PREFIX</entry>

<entry><constant id="CFG_FILE_STOP_PREFIX.const">CFG_FILE_STOP_PREFIX</constant></entry>

<entry>config file stop prefix</entry>

<entry>

Riadok 273 header).

Riadok 275 header).

</entry>

</row>

<row>

<entry>CFG_FILE_COMMENT_PREFIX</entry>

<entry><constant id="CFG_FILE_COMMENT_PREFIX.const">CFG_FILE_COMMENT_PREFIX</constant></entry>

<entry>config file comment prefix</entry>

<entry>

Riadok 284 and semicolon (<constant>;</constant>) i

Riadok 286 and semicolon (<constant>;</constant>) i

</entry>

</row>

<row>

<entry>CFG_FILE_MULTI_LINE_POSTFIX</entry>

<entry><constant id="CFG_FILE_MULTI_LINE_POSTFIX.const">CFG_FILE_MULTI_LINE_POSTFIX</constant></entry>

<entry>config file multi line postfix</entry>

<entry>

Riadok 297 line postfixes are removed from concaten

Riadok 299 line postfixes are removed from concaten

</entry>

</row>

<row>

<entry>CFG_FILE_NORMAL_MULTI_VALS_SEPARATOR</entry>

<entry><constant id="CFG_FILE_NORMAL_MULTI_VALS_SEPARATOR.const">CFG_FILE_NORMAL_MULTI_VALS_SEPARATOR</constant></entry>

<entry>normal config file multi values separator</entry>

<entry>

Riadok 312 val1,val2,val2</command>. Option must ha

Riadok 314 val1,val2,val2</command>. Option must ha

</entry>

</row>

<row>

<entry>CFG_FILE_LEFTOVER_MULTI_VALS_SEPARATOR</entry>

<entry><constant id="CFG_FILE_LEFTOVER_MULTI_VALS_SEPARATOR.const">CFG_FILE_LEFTOVER_MULTI_VALS_SEPARATOR</constant></entry>

<entry>leftover config file multi values separator</entry>

<entry>

Riadok 327 on command line and separated with space

Riadok 329 on command line and separated with space

</entry>

</row>

<row>

<entry>CFG_FILE_OPTION_ARG_SEPARATOR</entry>

<entry><constant id="CFG_FILE_OPTION_ARG_SEPARATOR.const">CFG_FILE_OPTION_ARG_SEPARATOR</constant></entry>

<entry>config file option argument separator</entry>

<entry>

Riadok 365 of real properties.

Riadok 367 of real properties.

</row>

</thead>

<tbody>

<row>

<entry>CFG_QUOTE</entry>

<entry><constant id="CFG_QUOTE.const">CFG_QUOTE</constant></entry>

<entry>

CFG_LINE_QUOTE_PREFIX,

<xref linkend="CFG_LINE_QUOTE_PREFIX.row"

CFG_LINE_QUOTE_POSTFIX,

endterm="CFG_LINE_QUOTE_PREFIX.const">,

CFG_FILE_QUOTE_PREFIX,

<xref linkend="CFG_LINE_QUOTE_POSTFIX.row"

CFG_FILE_QUOTE_POSTFIX

endterm="CFG_LINE_QUOTE_POSTFIX.const">,

<xref linkend="CFG_FILE_QUOTE_PREFIX.row"

endterm="CFG_FILE_QUOTE_PREFIX.const">,

<xref linkend="CFG_FILE_QUOTE_POSTFIX.row"

endterm="CFG_FILE_QUOTE_POSTFIX.const">

</entry>

</row>

<row>

<entry>CFG_LINE_QUOTE</entry>

<entry><constant id="CFG_LINE_QUOTE.const">CFG_LINE_QUOTE</constant></entry>

<entry>

CFG_LINE_QUOTE_PREFIX,

<xref linkend="CFG_LINE_QUOTE_PREFIX.row"

CFG_LINE_QUOTE_POSTFIX

endterm="CFG_LINE_QUOTE_PREFIX.const">,

<xref linkend="CFG_LINE_QUOTE_POSTFIX.row"

endterm="CFG_LINE_QUOTE_POSTFIX.const">

</entry>

</row>

<row>

<entry>CFG_FILE_QUOTE</entry>

<entry><constant id="CFG_FILE_QUOTE.const">CFG_FILE_QUOTE</constant></entry>

<entry>

CFG_FILE_QUOTE_PREFIX,

<xref linkend="CFG_FILE_QUOTE_PREFIX.row"

CFG_FILE_QUOTE_POSTFIX

endterm="CFG_FILE_QUOTE_PREFIX.const">,

<xref linkend="CFG_FILE_QUOTE_POSTFIX.row"

endterm="CFG_FILE_QUOTE_POSTFIX.const">

</entry>

</row>

<row>

<entry>CFG_QUOTE_PREFIX</entry>

<entry><constant id="CFG_QUOTE_PREFIX.const">CFG_QUOTE_PREFIX</constant></entry>

<entry>

CFG_LINE_QUOTE_PREFIX,

<xref linkend="CFG_LINE_QUOTE_PREFIX.row"

CFG_FILE_QUOTE_PREFIX

endterm="CFG_LINE_QUOTE_PREFIX.const">,

<xref linkend="CFG_FILE_QUOTE_PREFIX.row"

endterm="CFG_FILE_QUOTE_PREFIX.const">

</entry>

</row>

<row>

<entry>CFG_QUOTE_POSTFIX</entry>

<entry><constant id="CFG_QUOTE_POSTFIX.const">CFG_QUOTE_POSTFIX</constant></entry>

<entry>

CFG_LINE_QUOTE_POSTFIX,

<xref linkend="CFG_LINE_QUOTE_POSTFIX.row"

CFG_FILE_QUOTE_POSTFIX

endterm="CFG_LINE_QUOTE_POSTFIX.const">,

<xref linkend="CFG_FILE_QUOTE_POSTFIX.row"

endterm="CFG_FILE_QUOTE_POSTFIX.const">

</entry>

</row>

<row>

<entry>CFG_MULTI_VALS_SEPARATOR</entry>

<entry><constant id="CFG_MULTI_VALS_SEPARATOR.const">CFG_MULTI_VALS_SEPARATOR</constant></entry>

<entry>

CFG_LINE_NORMAL_MULTI_VALS_SEPARATOR,

<xref linkend="CFG_LINE_NORMAL_MULTI_VALS_SEPARATOR.row"

CFG_LINE_LEFTOVER_MULTI_VALS_SEPARATOR,

endterm="CFG_LINE_NORMAL_MULTI_VALS_SEPARATOR.const">,

CFG_FILE_NORMAL_MULTI_VALS_SEPARATOR,

<xref linkend="CFG_LINE_LEFTOVER_MULTI_VALS_SEPARATOR.row"

CFG_FILE_LEFTOVER_MULTI_VALS_SEPARATOR

endterm="CFG_LINE_LEFTOVER_MULTI_VALS_SEPARATOR.const">,

<xref linkend="CFG_FILE_NORMAL_MULTI_VALS_SEPARATOR.row"

endterm="CFG_FILE_NORMAL_MULTI_VALS_SEPARATOR.const">,

<xref linkend="CFG_FILE_LEFTOVER_MULTI_VALS_SEPARATOR.row"

endterm="CFG_FILE_LEFTOVER_MULTI_VALS_SEPARATOR.const">

</entry>

</row>

<row>

<entry>CFG_LINE_MULTI_VALS_SEPARATOR</entry>

<entry><constant id="CFG_LINE_MULTI_VALS_SEPARATOR.const">CFG_LINE_MULTI_VALS_SEPARATOR</constant></entry>

<entry>

CFG_LINE_NORMAL_MULTI_VALS_SEPARATOR,

<xref linkend="CFG_LINE_NORMAL_MULTI_VALS_SEPARATOR.row"

CFG_LINE_LEFTOVER_MULTI_VALS_SEPARATOR

endterm="CFG_LINE_NORMAL_MULTI_VALS_SEPARATOR.const">,

<xref linkend="CFG_LINE_LEFTOVER_MULTI_VALS_SEPARATOR.row"

endterm="CFG_LINE_LEFTOVER_MULTI_VALS_SEPARATOR.const">

</entry>

</row>

<row>

<entry>CFG_FILE_MULTI_VALS_SEPARATOR</entry>

<entry><constant id="CFG_FILE_MULTI_VALS_SEPARATOR.const">CFG_FILE_MULTI_VALS_SEPARATOR</constant></entry>

<entry>

CFG_FILE_NORMAL_MULTI_VALS_SEPARATOR,

<xref linkend="CFG_FILE_NORMAL_MULTI_VALS_SEPARATOR.row"

CFG_FILE_LEFTOVER_MULTI_VALS_SEPARATOR

endterm="CFG_FILE_NORMAL_MULTI_VALS_SEPARATOR.const">,

<xref linkend="CFG_FILE_LEFTOVER_MULTI_VALS_SEPARATOR.row"

endterm="CFG_FILE_LEFTOVER_MULTI_VALS_SEPARATOR.const">

</entry>

</row>

<row>

<entry>CFG_NORMAL_MULTI_VALS_SEPARATOR</entry>

<entry><constant id="CFG_NORMAL_MULTI_VALS_SEPARATOR.const">CFG_NORMAL_MULTI_VALS_SEPARATOR</constant></entry>

<entry>

CFG_LINE_NORMAL_MULTI_VALS_SEPARATOR,

<xref linkend="CFG_LINE_NORMAL_MULTI_VALS_SEPARATOR.row"

CFG_FILE_NORMAL_MULTI_VALS_SEPARATOR

endterm="CFG_LINE_NORMAL_MULTI_VALS_SEPARATOR.const">,

<xref linkend="CFG_FILE_NORMAL_MULTI_VALS_SEPARATOR.row"

endterm="CFG_FILE_NORMAL_MULTI_VALS_SEPARATOR.const">

</entry>

</row>

<row>

<entry>CFG_LEFTOVER_MULTI_VALS_SEPARATOR</entry>

<entry><constant id="CFG_LEFTOVER_MULTI_VALS_SEPARATOR.const">CFG_LEFTOVER_MULTI_VALS_SEPARATOR</constant></entry>

<entry>

CFG_LINE_LEFTOVER_MULTI_VALS_SEPARATOR,

<xref linkend="CFG_LINE_LEFTOVER_MULTI_VALS_SEPARATOR.row"

CFG_FILE_LEFTOVER_MULTI_VALS_SEPARATOR

endterm="CFG_LINE_LEFTOVER_MULTI_VALS_SEPARATOR.const">,

<xref linkend="CFG_FILE_LEFTOVER_MULTI_VALS_SEPARATOR.row"

endterm="CFG_FILE_LEFTOVER_MULTI_VALS_SEPARATOR.const">

</entry>

</row>

<row>

<entry>CFG_OPTION_ARG_SEPARATOR</entry>

<entry><constant id="CFG_OPTION_ARG_SEPARATOR.const">CFG_OPTION_ARG_SEPARATOR</constant></entry>

<entry>

CFG_LINE_OPTION_ARG_SEPARATOR,

<xref linkend="CFG_LINE_OPTION_ARG_SEPARATOR.row"

CFG_FILE_OPTION_ARG_SEPARATOR

endterm="CFG_LINE_OPTION_ARG_SEPARATOR.const">,

<xref linkend="CFG_FILE_OPTION_ARG_SEPARATOR.row"

endterm="CFG_FILE_OPTION_ARG_SEPARATOR.const">

</entry>

</row>

Riadok 452 CFG_FILE_OPTION_ARG_SEPARATOR

Riadok 480 CFG_FILE_OPTION_ARG_SEPARATOR

</table>

</para>

<para>

Following functions allows you to set up multiple properties and/or multiple

values for them in one call. They work just like <xref

linkend="usage.properties-virtual.table"

endterm="usage.properties-virtual.table.title">, but they are more flexible -

you can specify arbitrary properties. All these functions use variable number of

arguments.

</para>

<para>

<funcdef>int <function>cfg_clear_properties</function></funcdef>

<paramdef>CFG_CONTEXT <parameter>con</parameter></paramdef>