Modifies one or more file records, synchronously or asynchronously.
* hasError (only C) |
BOOL* |
|
Only in C functions: bool pointer used in the C functions that indicates the return of the function is a system error and must be communicated to the Linkar SERVER
|
* callback |
OperationAsyncCallbackString OperationAsyncCallbackLkrecords OperationAsyncCallbackClass ArrayList
|
|
Return type in asynchronous methods. For further information see ASYNCHRONOUS CALLS |
* credentialsOptions |
|
|
Object that defines the necessary data to access the database: Username, Password, EntryPoint, Language, FreeText. In the C Direct Functions, it is a char* |
* connectionInfo (only C) |
char* |
|
Only in C Persistent Functions: string that is returned by the Login function and contains all the necessary connection data. This data is necessary in persistent functions.
|
* filename |
string char*
|
|
Name of file being updated. |
* recordIds |
string char*
|
|
The list of record keys, separated by the Record Separator character (30) : LinkarCommon.ASCII_Chars.RS. |
* records
|
string char* |
|
Dynamic array records to be updated, separated by the Record Separator character (30) : LinkarCommon.ASCII_Chars.RS. |
originalRecords |
string char* |
|
Original records for Optimistic Lock verification, separated by the Record Separator character (30) : LinkarCommon.ASCII_Chars.RS.
|
updateOptions |
char*
|
null Nothing
|
Object of type UpdateOptions provides details about how the update operation(s) will be done. |
inputStringType
|
enum DataFormat.TYPE typedef uint8_t DataFormatTYPE;
|
DataFormat.TYPE.MV |
Format of the data being used to update record(s) : MV, XML or JSON. |
outputStringType |
enum DataFormat.TYPE typedef uint8_t DataFormatTYPE;
|
DataFormat.TYPE.MV |
Format of the data to be returned: MV, XML, XML_DICT, XML_JSCH, JSON, JSON_DICT, JSON_SCH. |
customVars |
string char* |
|
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. |
This function can generate exceptions.
In COM assemblies, a return value of type String will contain an error message if an error occurs when performing the operation.
optimistLockControl: when set to true, a copy of the record must be provided before the modification (originalRecords argument) to use the Optimistic Lock technique. This copy can be obtained from a previous Read operation. The database, before executing the modification, reads the record and compares it with the copy in originalRecords, if they are equal the modified record is executed. But if they are not equal, it means that the record has been modified by other user and its modification will not be saved. The record will have to be read, modified and saved again
