Click or drag to resize

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
)

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: String
Returns an object of type LkString with the results of the operation.
Exceptions
ExceptionCondition
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 = ""; // Buffer with the original record content (only necessary for use with optimistic lock control)
DATAFORMAT_TYPE outputStringType = DATAFORMAT_TYPE.MV;
string result = lkClt.Delete_Text(filename, recordId, deleteOptions, originalRecord, outputStringType, rxTimeout);
See Also