LinkarCltDelete Method (CredentialsOptions, String, String, DeleteOptions, String, String, Int32)

Deletes one or several records in file, in a synchronous 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 LkData Delete(
	CredentialsOptions credentialsOptions,
	string filename,
	string recordIds,
	DeleteOptions deleteOptions = null,
	string originalRecords = "",
	string customVars = "",
	int receiveTimeout = 0
)

Public Shared Function Delete ( 
	credentialsOptions As CredentialsOptions,
	filename As String,
	recordIds As String,
	Optional deleteOptions As DeleteOptions = Nothing,
	Optional originalRecords As String = "",
	Optional customVars As String = "",
	Optional receiveTimeout As Integer = 0
) As LkData

public:
static LkData^ Delete(
	CredentialsOptions^ credentialsOptions, 
	String^ filename, 
	String^ recordIds, 
	DeleteOptions^ deleteOptions = nullptr, 
	String^ originalRecords = L"", 
	String^ customVars = L"", 
	int receiveTimeout = 0
)

static member Delete : 
        credentialsOptions : CredentialsOptions * 
        filename : string * 
        recordIds : string * 
        ?deleteOptions : DeleteOptions * 
        ?originalRecords : string * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _deleteOptions = defaultArg deleteOptions null
        let _originalRecords = defaultArg originalRecords ""
        let _customVars = defaultArg customVars ""
        let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> LkData

Parameters

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 (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.
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: LkData
Returns an object of type LkData 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

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)
LkData lkDataDelete = LinkarClt.Delete(crdOpt, filename, recordId, deleteOptions, originalRecord);

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

Dim filename As String = "LK.CUSTOMERS"
Dim recordId As String = "99"
Dim inputData As String = "..." 'Buffer with the content of record to be delete
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 lkDataDelete As LkData = LinkarClt.Delete(crdOpt, filename, recordId, deleteOptions, originalRecord)

Reference

LinkarClt Class

Delete Overload

LinkarClient Namespace

LinkarCltAddLanguageSpecificTextSet("LST1BF2B3A6_0?cpp=::|nu=.");Delete Method (CredentialsOptions, String, String, DeleteOptions, String, String, Int32)

Parameters

Return Value

Reference

LinkarCltDelete Method (CredentialsOptions, String, String, DeleteOptions, String, String, Int32)