Please enable JavaScript to view this site.

Reads one or more file records

 

 

* filename

string

 

 

File name with source data.

* recordIds

string

 

 

The list of record keys, separated by the Record Separator character (30) : LinkarCommon.ASCII_Chars.RS.

If empty, use the readOptions parameter below.

dictClause

string

 


List of dictionary definitions IDs, separated by space. If definitions are not indicated the function will read the entire record.

readOptions

See below

 

null

Nothing

 

ReadOptions provides details about how the read operation(s) will be done.

outputStringType

 

 

 

 

Format of the data to be returned: MV, XML, XML_DICT, XML_SCH, JSON, JSON_DICT, JSON_SCH.

customVars

 

 

This is a free text field to send in the transaction. If not empty, subroutine SUB.LK.MAIN.CONTROL.CUSTOM will be called. Add custom code to that subroutine to define special behaviours for some or all transactions.

 

receiveTimeout

Numeric

 

-1

0

 

This is the maximum time in seconds that the client will wait for a response. Use 0 for no timeout. This is a function-specific override : -1 in a Persistent function defaults back to the timeout defined in the LinkarClt constructor.

 

readOptions. Contains the Read operations for the Read function

 

calculated

boolean

false

return the resulting values from the calculated dictionaries.

 

conversion

boolean

false

execute the defined conversions in the dictionaries before returning.

 

formatSpec

boolean

false

execute the defined formats in the dictionaries before returning.

 

originalRecords

boolean

false

return a copy of the records in MV format.