Navigation:  Classes > bArrayServer >

bArrayServer:GetLookupTable()

Print this Topic    Previous pageReturn to chapter overviewNext page

Purpose

Retrieves a two-column array of values from two fields in the server.

Class

bArrayServer

Type

Method

Syntax

<oArrayServer>:GetLookupTable(

[<iMaxRows>],

[<uField1>],

[<uField2>],

[<uSearchValue>]

) Æ auValue

Arguments

<iMaxRows>The maximum number of rows that should be retrieved. If omitted, 100 rows at most are retrieved.
Data Type:DWord

 

<uField1>The name, number, or symbol of the first field to be retrieved. If omitted, the first field is retrieved.
Data Type:DWord | String | Symbol

 

<uField2>The name, number, or symbol of the second field to be retrieved. If omitted, the second field is retrieved.
Data Type:DWord | String | Symbol

 

<uSearchValue>The value to be searched for, under the currently controlling order. The server performs a bArrayServer:Seek() operation, and then proceeds to load up the array from there.
Data Type:Usual

Return Value

auValueAn two-column array with the determined field values.
Data Type:Array

Description

bArrayServer:GetLookupTable() returns a two-column array of values found for the specified fields, moving sequentially until the specified maximum number of rows or until end of file (see also bArrayServer:EoF). If a filter, scope or selective relation is active, the method includes only records from that selection. The values are retrieved under the current controlling order, if any.

 

Important notes!
The method does not reposition to the beginning of the records before starting to fill the array. Either provide a start value or explicitly position the server before using the method.
 
The method sends a NotifyIntentToMove message before the operation. It sends a NotifyRecordChange message upon completion and leaves the server positioned at the last record used or at end of file (last file record).

See Also

bArrayServer:EoF

bArrayServer:Eval()

bArrayServer:Notify()

bArrayServer:Seek()

 


Page url: http://www.YOURSERVER.com/index.html?barrayserver_getlookuptable.htm