:Revision=3
:html
<<
128.135
KIList-Object|KIList
--
The IP-Object <!RW>KIList provides methods for accessing the currently loaded KI-list.

The records of the KI-list are accessed sequentially. Only the fields of the current record can be read.
>>

<<
128.135.1
Functions of the KIList-Object|Functions
--
>>

<<
128.135.1.1
KIList.EOF|EOF
--
<!DEF>
function <!TW>KIList.EOF : real;
<!TXT>
Returns <!RW>TRUE, if the end of the list has been reached with <!RW>KIList.Next or if no matching record is found after a filter operation.
>>

<<
128.135.1.2
KIList.Count|Count
--
<!DEF>
function <!TW>KIList.Count : real;
<!TXT>
Returns the number of the records that are visible at the moment (and match the filter requirement).
>>

<<
128.135.1.3
KIList.IsActive|IsActive
--
<!DEF>
function <!TW>KIList.IsActive : real;
<!TXT>
Returns <!RW>TRUE, if the KI-list is activated in the basic setup.
>>

<<
128.135.2
Procedures of the File-Object|Procedures
--
>>

<<
128.135.2.1
KIList.Load|Load
--
<!DEF>
procedure <!TW>KIList.Load (sFileName : string);
<!TXT>
Loads a new KI-list. Leads to run time errors if the KI-list is not avaialble or if it is incorrect. 

The default-directory is the type data directory, the default-suffix is &quot;TXT&quot;.

Deletes all the set filters and sets the internal list pointer on the first record.
>>

<<
128.135.2.2
KIList.First|First
--
<!DEF>
procedure <!TW>KIList.First;
<!TXT>
Sets the internal list pointer on the first KI-list input which matches the set filter criteria.
>>

<<
128.135.2.3
KIList.Next|Next
--
<!DEF>
procedure <!TW>KIList.Next;
<!TXT>
Sets the internal list pointer on the next KI-list input which matches the set filter criteria.
>>

<<
128.135.4
Sub object KIList.Field|Field
--
The sub object field returns information about a single field (a column) of the KI-list.
>>

<<
128.135.4.1
KIList.Field.Get|Get
--
<!DEF>
function <!TW>KIList.Field.Get (sFeld : string [; sFilter : string]) : string;
<!TXT>
Returns the value of <!PW>the sFeld field of the KI-list input shown by the internal list pointer.

If <!PW>sFilter is not specified, the filter introduced in the KI-list is used. If <!PW>sFilter is specified, then sFilter is used as filter. In this case the <!PW>sFilter is extended, if necessary, with '?' to the length of the value. So, a value of '' (empty string) for the <!PW>sFilter returns a value which is not filtered!

Returns '', if the field does not exist or if the end of the list was overstepped.
>>

<<
128.135.4.2
KIList.Field.Exists|Exists
--
<!DEF>
function <!TW>KIList.Field.Exists (sFeld : string) : real;
<!TXT>
Returns <!RW>TRUE, if the KI-list contains a field with the name sFeld.
>>

<<
128.135.4.3
KIList.Field.Count|Count
--
<!DEF>
function <!TW>KIList.Field.Count : real;
<!TXT>
Returns the number of fields defined in the header.
>>

<<
128.135.4.4
KIList.Field.Name|Name
--
<!DEF>
function <!TW>KIList.Field.Name (nNr : real) : string;
<!TXT>
Returns the heading with defined names of the <!PW>nNr-th field  (1 &lt;= <!PW>nNr &lt;= <!RW>KIList.Field.Count).

If <!PW>nNr is outside the valid range, then '' (empty string) is returned.
>>

<<
128.135.5
Sub object KIList.Filter|Filter
--
The sub-object <!PW>Filter allows to set filters in the KI-lists in order to be able to filter the necessary records one-byone. 

The new filter is built up on the old filter. 

The filters can be deleted only all together.
>>

<<
128.135.5.1
KIList.Filter.Set|Set
--
<!DEF>
procedure <!TW>KIList.Filter.Set (sFeld, sSetValue : string [; rMasked : real]);
<!TXT>
Sets a filter.

From now only those KI-list inputs are visible whose <!PW>sFeld field matches the <!PW>sSetValue. If <!PW>rMasked is <!RW>True, then the <!PW>sSetValue is compared to the values filtered by the field-characteristic mask. '?' is a joker.

Sets pointer to the first visible record.

If the field <!PW>sFeld does not exist, a run time error is generated.
>>

<<
128.135.5.1
KIList.Filter.Off|Off
--
<!DEF>
procedure <!TW>KIList.Filter.Off;
<!TXT>
Disables all the previously set filters. 

Sets the pointer to the first visible record.
>>
