DeleteAsync_Text Method (LinkarClt.OperationAsyncCallbackString, CredentialsOptions, String, String, DeleteOptions, String, DATAFORMAT_TYPE, String, Int32)

LinkarCltDeleteAsync_Text Method (LinkarCltOperationAsyncCallbackString, CredentialsOptions, String, String, DeleteOptions, String, DATAFORMAT_TYPE, String, Int32)

Deletes one or several records in file, in a asynchronous way

Direct 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

C++

Copy

public static void DeleteAsync_Text(
	OperationAsyncCallbackString cmdDeleteFinished,
	CredentialsOptions credentialsOptions,
	string filename,
	string recordIds,
	DeleteOptions deleteOptions,
	string originalRecords = "",
	DATAFORMAT_TYPE outputStringType = DATAFORMAT_TYPE.MV,
	string customVars = "",
	int receiveTimeout = 0
)

Public Shared Sub DeleteAsync_Text ( 
	cmdDeleteFinished As OperationAsyncCallbackString,
	credentialsOptions As CredentialsOptions,
	filename As String,
	recordIds As String,
	deleteOptions As DeleteOptions,
	Optional originalRecords As String = "",
	Optional outputStringType As DATAFORMAT_TYPE = DATAFORMAT_TYPE.MV,
	Optional customVars As String = "",
	Optional receiveTimeout As Integer = 0
)

public:
static void DeleteAsync_Text(
	OperationAsyncCallbackString^ cmdDeleteFinished, 
	CredentialsOptions^ credentialsOptions, 
	String^ filename, 
	String^ recordIds, 
	DeleteOptions^ deleteOptions, 
	String^ originalRecords = L"", 
	DATAFORMAT_TYPE outputStringType = DATAFORMAT_TYPE::MV, 
	String^ customVars = L"", 
	int receiveTimeout = 0
)

static member DeleteAsync_Text : 
        cmdDeleteFinished : OperationAsyncCallbackString * 
        credentialsOptions : CredentialsOptions * 
        filename : string * 
        recordIds : string * 
        deleteOptions : DeleteOptions * 
        ?originalRecords : string * 
        ?outputStringType : DATAFORMAT_TYPE * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _originalRecords = defaultArg originalRecords ""
        let _outputStringType = defaultArg outputStringType DATAFORMAT_TYPE.MV
        let _customVars = defaultArg customVars ""
        let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> unit

Parameters

cmdDeleteFinished: Type: LinkarClientOperationAsyncCallbackString
Return type in asynchronous methods
credentialsOptions: Type: LinkarCommonCredentialsOptions
Object that defines the necessary data to access to the Linkar Server: Username, Password, EntryPoint, Language, FreeText.
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: 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).

Examples

C++

Copy

CredentialsOptions crdOpt = new CredentialsOptions("127.0.0.1", 11300, "admin", "admin", "ENTRYPOINT");

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;
LinkarClt.DeleteAsync_Text(new LinkarClt.OperationAsyncCallbackString(DeleteAsyncFinished), crdOpt, filename, recordId, deleteOptions, originalRecord, outputStringType);

Dim crdOpt As CredentialsOptions = New CredentialsOptions("127.0.0.1", 11300, "admin", "admin", "ENTRYPOINT")

Dim filename As String = "LK.CUSTOMERS"
Dim recordId As String = "9"
Dim deleteOptions As DeleteOptions = New DeleteOptions
Dim originalRecord As String = "" 'Buffer with the original record content (only necessary for use with optimistic lock control)
Dim outputStringType As DATAFORMAT_TYPE = DATAFORMAT_TYPE.MV
LinkarClt.DeleteAsync_Text(New LinkarClt.OperationAsyncCallbackString(DeleteAsyncFinished), crdOpt, filename, recordId, deleteOptions, originalRecord, outputStringType)

Reference

LinkarClt Class

DeleteAsync_Text Overload

LinkarClient Namespace

LinkarCltAddLanguageSpecificTextSet("LST5E533FA2_0?cpp=::|nu=.");DeleteAsync_Text Method (LinkarCltAddLanguageSpecificTextSet("LST5E533FA2_1?cpp=::|nu=.");OperationAsyncCallbackString, CredentialsOptions, String, String, DeleteOptions, String, DATAFORMAT_TYPE, String, Int32)

Parameters

Reference

LinkarCltDeleteAsync_Text Method (LinkarCltOperationAsyncCallbackString, CredentialsOptions, String, String, DeleteOptions, String, DATAFORMAT_TYPE, String, Int32)