file.getRecord()
This API fetches the record specified by the search argument from the file.
Parameters
search argument
The value can be anumber
,string
, orarray
value specifying arelative record number
(RRN
),key value
, orlist of key values
(array
ofnumber
/string
).don't lock (optional)
Aboolean
true
can be passed to avoid locking the record if the file is open forupdate
/delete
. If this parameter is set toboolean
false
or omitted records will be locked forupdate
/delete
files.record format name (optional)
Astring
value specifying the record format name can be passed.input data structure (optional)
A Profound.jsdata structure reference
can be passed.
If specified, the referenced data structure will be populated with the record data. If the data structure is not qualified, you must wrap the parameter with the pjs.ds() API.
RPG Equivalent
CHAIN
Exception Handling
An Error instance will be thrown with the following properties:
- message - The message text.
- error - The message id.
- help - The message help text.
Example
pjs.defineTable("myfile", { keyed: true, read: true }); myfile.getRecord(101); if (myfile.found()) doSomething();
Video Tutorial
Some documentation pages have recently moved to a new section: Profound AppDev. If you are having trouble finding specific pages, try the documentation search capability or reach out to our Support team!