Platon Technologies
not logged in Login Registration
EnglishSlovak
open source software development celebrating 10 years of open source development! Saturday, October 17, 2026
[BACK] [TXT][DIR] Up to [Platon] / libcfg+ / doc / sgml

Diff for libcfg+/doc/sgml/usage.properties.sgml between version 1.10 and 1.11

version 1.10, 2003/04/24 21:58:21 version 1.11, 2003/08/24 19:50:20
Line 1 
Line 1 
 <!-- $Platon: libcfg+/doc/sgml/usage.properties.sgml,v 1.9 2003/03/01 02:26:20 nepto Exp $ -->  <!-- $Platon: libcfg+/doc/sgml/usage.properties.sgml,v 1.10 2003/04/24 21:58:21 rajo Exp $ -->
   
 <!-- MAN:  <!-- MAN:
         <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [          <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
Line 58  work also with virtual properties as wel
Line 58  work also with virtual properties as wel
 <!-- MAN: </refsect1><refsect1><title>DESCRIPTION</title> -->  <!-- MAN: </refsect1><refsect1><title>DESCRIPTION</title> -->
 <para>  <para>
   
 Imagine one property as set of strings.  Function  Given the context <parameter>con</parameter>, the functions perform the following tasks:
 <function>cfg_clear_property()</function> clears all strings of property  
 specified by <parameter>type</parameter> parameter in context  <itemizedlist spacing="compact">
 <parameter>con</parameter>. Similary, function          <listitem><para>
 <function>cfg_add_property()</function> adds one string                          Function <function>cfg_clear_property()</function> clears the
 <parameter>str</parameter> to property specified by <parameter>type</parameter>                          property <parameter>type</parameter> of any values it might have
 parameter in context <parameter>con</parameter>. Behaviour of                          accumulated.
 <function>cfg_remove_property()</function> is analogical. It removes one string          </para></listitem>
 from property. All these functions return <constant>1</constant> on success or          <listitem><para>
 <constant>0</constant> on not enough memory error.                          Function <function>cfg_add_property()</function> adds a new value
                           <parameter>str</parameter> to the property
                           <parameter>type</parameter>.
           </para></listitem>
           <listitem><para>
                           Function <function>cfg_remove_property()</function> removes a
                           value <parameter>str</parameter> from the property
                           <parameter>type</parameter>.
           </para></listitem>
   </itemizedlist>
   
 </para>  </para>
 <para>  <para>
Line 582  arguments.
Line 591  arguments.
 <!-- MAN: </refsect1><refsect1><title>DESCRIPTION</title> -->  <!-- MAN: </refsect1><refsect1><title>DESCRIPTION</title> -->
 <para>  <para>
   
 Usage of this functions is basically straightforward. It is up to you, how many  Given the context <parameter>con</parameter> the functions provide the
 properties you will set in call. Using functions  following functionality:
 <function>cfg_add_properties()</function> and  
 <function>cfg_remove_properties()</function> it is possible, to specify  
 arbitrary amount of <parameter>type</parameter>/<parameter>str</parameter>  
 combinations. You should end list of parameters with either  
 <constant>CFG_EOT</constant> (end of type) constant for  
 <parameter>type</parameter> parameter and/or <constant>NULL</constant> value for  
 <parameter>str</parameter> parameter.  
   
 </para>  <itemizedlist spacing="compact">
 <para>          <listitem>
                   <para>
 If you want to set or remove multiple string values for one property, there are  
 function <function>cfg_add_properties_type()</function> and  Function <function>cfg_clear_properties()</function> removes all values from the list
 <function>cfg_remove_properties_type()</function> present for doing this. Specify  of properties specified by the variable length parameter
 one <parameter>type</parameter> parameter and multiple  <parameter>type</parameter>. The property list must be terminated by the
 <parameter>str</parameter> parameters ended with <constant>NULL</constant> in  <constant>CFG_EOT</constant> constant.
 function call.  
                   </para>
           </listitem>
           <listitem>
                   <para>
   
   Functions <function>cfg_add_properties()</function> and
   <function>cfg_remove_properties()</function> give you the ability to add and
   remove multiple property/value pairs. The property/value pairs are designated
   by the variable length parameters <parameter>type</parameter> and
   <parameter>str</parameter> correspondingly. The property list must be
   terminated with <constant>CFG_EOT</constant> and the value list must be
   terminated with <constant>NULL</constant>.
   
                   </para>
           </listitem>
           <listitem>
                   <para>
   
   Functions <function>cfg_add_properties_type()</function> and
   <function>cfg_remove_properties_type()</function> add and remove multiple
   values specified by the variable parameter <parameter>str</parameter> to and
   from a single property denoted by <parameter>type</parameter>. The value list
   should be terminated with <constant>NULL</constant>.
   
                   </para>
           </listitem>
           <listitem>
                   <para>
   
   Functions <function>cfg_add_properties_str()</function> and
   <function>cfg_remove_properties_str()</function> add and remove the value
   denoted by <parameter>str</parameter> to and from the list of properties
   specified by the variable length parameter <parameter>type</parameter>. The
   property list must be terminated with <constant>CFG_EOT</constant>.
   
                   </para>
           </listitem>
   </itemizedlist>
   
 </para>  </para>
 <para>  <para>
   
 Likewise for setting one string value for multiple properties, there are  As with the single-property functions, all of these functions return
 functions <function>cfg_add_properties_str()</function> and  <constant>1</constant> on success or <constant>0</constant> on not enough
 <function>cfg_remove_properties_str()</function>. Specify one  memory error.
 <parameter>str</parameter> parameter and multiple <parameter>type</parameter>  
 parameters ended with <constant>CFG_EOT</constant> in function call.  
   
 </para>  </para>
   
 </sect1>  </sect1>
 <!-- MAN: </refsect1></refentry> -->  <!-- MAN: </refsect1></refentry> -->
   
Legend:
Removed from v.1.10  
changed lines
  Added in v.1.11
Platon Group <platon@platon.org> http://platon.org/
Copyright © 2002-2006 Platon Group
Site powered by Metafox CMS 		Go to Top