main_tinifile.htm

   1 <html>
   2 <head>
   3 <title>KOL Help: TIniFile object (main frame)</title>
   4 <base target="_top">
   5 </head>
   6
   7 <body bgcolor="#FFFFEF" text="#000000" link="#008080" vlink="#008000" alink="#808000">
   8 <p><font face="Courier" color="#800080"><b>TIniFile( unit <a href=kol_pas.htm>KOL.pas</a> )
   9  <font face="Wingdings">ï</font> <a href=tobj.htm>TObj</a>
  10  <font face="Wingdings">ï</font> <a href=_tobj.htm>_TObj</a>
  11 </b></font></p>
  12 <p><b>
  13 TIniFile = object( <a href=tobj.htm target="_top">TObj</a> )
  14 </b></p>
  15 Ini file incapsulation. The main feature is what the same block of
  16 read-write operations could be defined (difference must be only in
  17 <a href=#mode target="main">Mode</a> value).
  18 &nbsp;&nbsp;&nbsp;<a href="Inifilesample.htm"><font face="Webdings" size=7>&#181;</font></a>&nbsp;&nbsp;&nbsp;
  19 <h3 align="center"><font color="#FF8080">TIniFile properties</font></h3>
  20 <a name="mode"></a>
  21 <p>
  22 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>Mode</b></font>: <a href=kol_pas.htm#tinifilemode target="_top">TIniFileMode</a>;</font>
  23 <br>
  24 ifmWrite, if write data to ini-file rather than read it.
  25 </p>
  26 <a name="filename"></a>
  27 <p>
  28 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>FileName</b></font>: <b>String</b>;</font>
  29 &nbsp;&nbsp;&nbsp;<font face="Webdings" size=7>&#209;</font>&nbsp;&nbsp;&nbsp;
  30 <br>
  31 Ini file name.
  32 </p>
  33 <a name="section"></a>
  34 <p>
  35 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>Section</b></font>: <b>String</b>;</font>
  36 <br>
  37 Current ini section.
  38 </p>
  39 <h4 align="center"><font color="black">Properties, inherited from <a href="tobj.htm" target="_top">TObj</a></font></h4>
  40 <h3 align="center"><font color="#FF8080">TIniFile methods</font></h3>
  41 <a name="destroy"></a>
  42 <p>
  43 <font face="Courier" color="#800080"><b>destructor</b> <font color="#808000"><b>Destroy</b></font>; <b>virtual</b>;</font>
  44 <br>
  45 destructor
  46 </p>
  47 <a name="valueinteger"></a>
  48 <p>
  49 <font face="Courier" color="#800080"><b>function</b> <font color="#808000"><b>ValueInteger</b></font>( <b>const</b> Key: <b>String</b>; Value: <b>Integer</b> ): <b>Integer</b>;</font>
  50 <br>
  51 Reads or writes integer data value.
  52 </p>
  53 <a name="valuestring"></a>
  54 <p>
  55 <font face="Courier" color="#800080"><b>function</b> <font color="#808000"><b>ValueString</b></font>( <b>const</b> Key: <b>String</b>; <b>const</b> Value: <b>String</b> ): <b>String</b>;</font>
  56 <br>
  57 Reads or writes string data value.
  58 </p>
  59 <a name="valueboolean"></a>
  60 <p>
  61 <font face="Courier" color="#800080"><b>function</b> <font color="#808000"><b>ValueBoolean</b></font>( <b>const</b> Key: <b>String</b>; Value: <b>Boolean</b> ): <b>Boolean</b>;</font>
  62 <br>
  63 Reads or writes boolean data value.
  64 </p>
  65 <a name="valuedata"></a>
  66 <p>
  67 <font face="Courier" color="#800080"><b>function</b> <font color="#808000"><b>ValueData</b></font>( <b>const</b> Key: <b>String</b>; Value: <b>Pointer</b>; Count: <b>Integer</b> ): <b>Boolean</b>;</font>
  68 <br>
  69 Reads or writes data from/to buffer. Returns True, if success.
  70 </p>
  71 <a name="clearall"></a>
  72 <p>
  73 <font face="Courier" color="#800080"><b>procedure</b> <font color="#808000"><b>ClearAll</b></font>;</font>
  74 <br>
  75 Clears all sections of ini-file.
  76 </p>
  77 <a name="clearsection"></a>
  78 <p>
  79 <font face="Courier" color="#800080"><b>procedure</b> <font color="#808000"><b>ClearSection</b></font>;</font>
  80 <br>
  81 Clears current <a href=#section target="main">Section</a> of ini-file.
  82 </p>
  83 <a name="clearkey"></a>
  84 <p>
  85 <font face="Courier" color="#800080"><b>procedure</b> <font color="#808000"><b>ClearKey</b></font>( <b>const</b> Key: <b>String</b> );</font>
  86 <br>
  87 Clears given key in current section.
  88 </p>
  89 <a name="getsectionnames"></a>
  90 <p>
  91 <font face="Courier" color="#800080"><b>procedure</b> <font color="#808000"><b>GetSectionNames</b></font>( Names: PStrList );</font>
  92 <br>
  93 Retrieves section names, storing it in string list passed as a parameter.
  94 String list does not cleared before processing. <a href=#section target="main">Section</a> names are added
  95 to the end of the string list.
  96 </p>
  97 <a name="sectiondata"></a>
  98 <p>
  99 <font face="Courier" color="#800080"><b>procedure</b> <font color="#808000"><b>SectionData</b></font>( Names: PStrList );</font>
 100 <br>
 101 Read/write current section content to/from string list. (Depending on
 102 current <a href=#mode target="main">Mode</a> value).
 103 </p>
 104 <h4 align="center"><font color="black">Methods, inherited from <a href="tobj.htm" target="_top">TObj</a></font></h4>
 105 <h3 align="center"><font color="#FF8080">TIniFile events</font></h3>
 106 <h4 align="center"><font color="black">Events, inherited from <a href="tobj.htm" target="_top">TObj</a></font></h4>
 107 <h3 align="center"><font color="#FF8080">TIniFile fields</font></h3>
 108 <h4 align="center"><font color="black">Fields, inherited from <a href="tobj.htm" target="_top">TObj</a></font></h4>
 109 <hr>
 110 <p align="center">[&nbsp;<a href=index.htm>Index</a>&nbsp;]</p>
 111 <p align="center"><font face="Comic Sans MS"><small>This help is generated 22-Sep-2005 by KOL Help generator, (C) 2000-2001 by Vladimir Kladov<br>Modified (C) 2003 by Alexander Bartov</small></font></p>
 112 </body>
 113 </html>