| LinkarCltDelete_Text Method (String, String, DeleteOptions, String, DATAFORMAT_TYPE, String, Int32) |
Deletes one or several records in file, in a synchronous way
Persistent Method.
Namespace:
LinkarClient
Assemblies:
LinkarClientCore (in LinkarClientCore.dll) Version: 2.1.0.0
LinkarClientMono (in LinkarClientMono.dll) Version: 2.1.0.0 (2.1.0.0)
LinkarClient (in LinkarClient.dll) Version: 2.1.0.0 (2.1.0.0)
Syntax public string Delete_Text(
string filename,
string recordIds,
DeleteOptions deleteOptions = null,
string originalRecords = "",
DATAFORMAT_TYPE outputStringType = DATAFORMAT_TYPE.MV,
string customVars = "",
int receiveTimeout = -1
)
Public Function Delete_Text (
filename As String,
recordIds As String,
Optional deleteOptions As DeleteOptions = Nothing,
Optional originalRecords As String = "",
Optional outputStringType As DATAFORMAT_TYPE = DATAFORMAT_TYPE.MV,
Optional customVars As String = "",
Optional receiveTimeout As Integer = -1
) As String
public:
String^ Delete_Text(
String^ filename,
String^ recordIds,
DeleteOptions^ deleteOptions = nullptr,
String^ originalRecords = L"",
DATAFORMAT_TYPE outputStringType = DATAFORMAT_TYPE::MV,
String^ customVars = L"",
int receiveTimeout = -1
)
member Delete_Text :
filename : string *
recordIds : string *
?deleteOptions : DeleteOptions *
?originalRecords : string *
?outputStringType : DATAFORMAT_TYPE *
?customVars : string *
?receiveTimeout : int
(* Defaults:
let _deleteOptions = defaultArg deleteOptions null
let _originalRecords = defaultArg originalRecords ""
let _outputStringType = defaultArg outputStringType DATAFORMAT_TYPE.MV
let _customVars = defaultArg customVars ""
let _receiveTimeout = defaultArg receiveTimeout -1
*)
-> string
Parameters
- filename
- Type: SystemString
It's the file name where the records are going to be deleted. DICT in case of deleting a record that belongs to a dictionary. - recordIds
- Type: SystemString
It's the records codes list to be deleted separated by Record Separator (30) character. - deleteOptions (Optional)
- Type: LinkarCommonDeleteOptions
Object that defines the different Function options: optimisticLockControl, recoverRecordIdType. - originalRecords (Optional)
- Type: SystemString
Are the original records separated by Record Separator (30) character, that you want to delete for optimist block checking. - outputStringType (Optional)
- Type: LinkarCommonDATAFORMAT_TYPE
Indicates in what format you want to receive the data resulting from the operation: MV, XML or JSON. - customVars (Optional)
- Type: SystemString
It's a free text that will travel until the database to make the admin being able to manage additional behaviours in the standard routine SUB.LK.MAIN.CONTROL.CUSTOM. This routine will be called if the argument has content.
- receiveTimeout (Optional)
- Type: SystemInt32
It's the maximum time in seconds that the client will keep waiting the answer by the server. By default -1 (wait indefinitely).
Return Value
Type:
StringReturns an object of type
LkString with the results of the operation.
Exceptions Exception | Condition |
---|
SocketException | Thrown when there are communication problems between LINKAR Client and LINKAR Server |
LkException | Thrown when there are errors in LINKAR Client or LINKAR Server |
Examples LinkarClt lkClt = new LinkarClt();
CredentialsOptions crdOpt = new CredentialsOptions("127.0.0.1", 11300, "admin", "admin", "ENTRYPOINT");
lkClt.Login(crdOpt);
string filename = "LK.CUSTOMERS";
string recordId = "99";
DeleteOptions deleteOptions = new DeleteOptions();
string originalRecord = "";
DATAFORMAT_TYPE outputStringType = DATAFORMAT_TYPE.MV;
string result = lkClt.Delete_Text(filename, recordId, deleteOptions, originalRecord, outputStringType, rxTimeout);
Dim lkClt As LinkarClt = New LinkarClt
Dim crdOpt As CredentialsOptions = New CredentialsOptions("127.0.0.1", 11300, "admin", "admin", "ENTRYPOINT")
lkClt.Login(crdOpt)
Dim filename As String = "LK.CUSTOMERS"
Dim recordId As String = "99"
Dim deleteOptions As DeleteOptions = New DeleteOptions
Dim originalRecord As String = ""
Dim outputStringType As DATAFORMAT_TYPE = DATAFORMAT_TYPE.MV
Dim result As String = lkClt.Delete_Text(filename, recordId, deleteOptions, originalRecord, outputStringType, rxTimeout)
No code example is currently available or this language may not be supported.
No code example is currently available or this language may not be supported.
See Also