| LinkarClientDelete Method |
Linkar Framework for .NET and Core
Deletes one or several records in file, synchronously only
Namespace: Linkar.Functions.PersistentAssembly: Linkar.Functions.Persistent (in Linkar.Functions.Persistent.dll) Version: 2.3.1
Syntax public string Delete(
string filename,
string records,
DeleteOptions deleteOptions = null,
DATAFORMAT_TYPE inputFormat = DATAFORMAT_TYPE.MV,
DATAFORMAT_TYPE outputFormat = DATAFORMAT_TYPE.MV,
string customVars = "",
int receiveTimeout = 0
)
Public Function Delete (
filename As String,
records As String,
Optional deleteOptions As DeleteOptions = Nothing,
Optional inputFormat As DATAFORMAT_TYPE = DATAFORMAT_TYPE.MV,
Optional outputFormat As DATAFORMAT_TYPE = DATAFORMAT_TYPE.MV,
Optional customVars As String = "",
Optional receiveTimeout As Integer = 0
) As String
public:
String^ Delete(
String^ filename,
String^ records,
DeleteOptions^ deleteOptions = nullptr,
DATAFORMAT_TYPE inputFormat = DATAFORMAT_TYPE::MV,
DATAFORMAT_TYPE outputFormat = DATAFORMAT_TYPE::MV,
String^ customVars = L"",
int receiveTimeout = 0
)
member Delete :
filename : string *
records : string *
?deleteOptions : DeleteOptions *
?inputFormat : DATAFORMAT_TYPE *
?outputFormat : DATAFORMAT_TYPE *
?customVars : string *
?receiveTimeout : int
(* Defaults:
let _deleteOptions = defaultArg deleteOptions null
let _inputFormat = defaultArg inputFormat DATAFORMAT_TYPE.MV
let _outputFormat = defaultArg outputFormat DATAFORMAT_TYPE.MV
let _customVars = defaultArg customVars ""
let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> string
Parameters
- filename String
- The file name where the records are going to be deleted. DICT in case of deleting a record that belongs to a dictionary.
- records String
- Buffer of records to be deleted. Use StringFunctions.ComposeDeleteBuffer (Linkar.Strings library) function to compose this string.
- deleteOptions DeleteOptions (Optional)
- Object with options to manage how records are deleted, including optimisticLockControl, recoverRecordIdType.
- inputFormat DATAFORMAT_TYPE (Optional)
- Indicates in what format you wish to send the resultant writing data: MV, XML or JSON.
- outputFormat DATAFORMAT_TYPE (Optional)
- Indicates in what format you want to receive the data resulting from the operation: MV, XML or JSON.
- customVars String (Optional)
- Free text sent to the database allows management of additional behaviours in SUB.LK.MAIN.CONTROL.CUSTOM, which is called when this parameter is set.
- receiveTimeout Int32 (Optional)
- Maximum time in seconds that the client will wait for a response from the server. Default = 0 to wait indefinitely.
Return Value
StringThe results of the operation.
Remarks
Inside the records argument, the recordIds always must be specified. But the originalRecords not always.
When
deleteOptions argument is specified and the
OptimisticLockControl property is set to true,
a copy of the record must be provided before the deletion (originalRecords argument) to use the Optimistic Lock technique.
This copy can be obtained from a previous
Read(String, String, String, ReadOptions, DATAFORMAT_TYPE, DATAFORMATCRU_TYPE, String, Int32) operation. The database, before executing the deletion,
reads the record and compares it with the copy in originalRecords, if they are equal the record is deleted.
But if they are not equal, it means that the record has been modified by other user and the record will not be deleted.
The record will have to be read, and deleted again.
See Also