LinkarCltUpdate_Text Method (CredentialsOptions, String, String, String, UpdateOptions, String, DATAFORMAT_TYPE, DATAFORMATCRU_TYPE, String, Int32)

Update one or several records of a 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 string Update_Text(
	CredentialsOptions credentialsOptions,
	string filename,
	string recordIds,
	string records,
	UpdateOptions updateOptions = null,
	string originalRecords = "",
	DATAFORMAT_TYPE inputStringType = DATAFORMAT_TYPE.MV,
	DATAFORMATCRU_TYPE outputStringType = DATAFORMATCRU_TYPE.MV,
	string customVars = "",
	int receiveTimeout = 0
)

Public Shared Function Update_Text ( 
	credentialsOptions As CredentialsOptions,
	filename As String,
	recordIds As String,
	records As String,
	Optional updateOptions As UpdateOptions = Nothing,
	Optional originalRecords As String = "",
	Optional inputStringType As DATAFORMAT_TYPE = DATAFORMAT_TYPE.MV,
	Optional outputStringType As DATAFORMATCRU_TYPE = DATAFORMATCRU_TYPE.MV,
	Optional customVars As String = "",
	Optional receiveTimeout As Integer = 0
) As String

public:
static String^ Update_Text(
	CredentialsOptions^ credentialsOptions, 
	String^ filename, 
	String^ recordIds, 
	String^ records, 
	UpdateOptions^ updateOptions = nullptr, 
	String^ originalRecords = L"", 
	DATAFORMAT_TYPE inputStringType = DATAFORMAT_TYPE::MV, 
	DATAFORMATCRU_TYPE outputStringType = DATAFORMATCRU_TYPE::MV, 
	String^ customVars = L"", 
	int receiveTimeout = 0
)

static member Update_Text : 
        credentialsOptions : CredentialsOptions * 
        filename : string * 
        recordIds : string * 
        records : string * 
        ?updateOptions : UpdateOptions * 
        ?originalRecords : string * 
        ?inputStringType : DATAFORMAT_TYPE * 
        ?outputStringType : DATAFORMATCRU_TYPE * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _updateOptions = defaultArg updateOptions null
        let _originalRecords = defaultArg originalRecords ""
        let _inputStringType = defaultArg inputStringType DATAFORMAT_TYPE.MV
        let _outputStringType = defaultArg outputStringType DATAFORMATCRU_TYPE.MV
        let _customVars = defaultArg customVars ""
        let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> string

Parameters

credentialsOptions: Type: LinkarCommonCredentialsOptions
Object that defines the necessary data to access to the Linkar Server: Username, Password, EntryPoint, Language, FreeText.
filename: Type: SystemString
File name where you are going to write.
recordIds: Type: SystemString
It's the records codes list you want to register, separated by the Record Separator character (30).
records: Type: SystemString
Are the records you want to update, separated by the Record Separator character (30).
updateOptions (Optional): Type: LinkarCommonUpdateOptions
Object that defines the different writing options of the Function: optimisticLockControl, readAfter, calculated, dictionaries, conversion, formatSpec, originalRecords.
originalRecords (Optional): Type: SystemString
Are the original records that you want to update for Optimistic Block verifications, separated by the Record Separator character (30).
inputStringType (Optional): Type: LinkarCommonDATAFORMAT_TYPE
Indicates in what format you wish to send the resultant writing data: MV, XML or JSON.
outputStringType (Optional): Type: LinkarCommonDATAFORMATCRU_TYPE
Indicates in what format you want to receive the data resulting from the Read, New, Update and Select operations: MV, XML, XML_DICT, XML_SCH, JSON, JSON_DICT or JSON_SCH.
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

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 = "1";
string inputData = "..."; // Buffer with the content of record to be update
UpdateOptions updateOptions = new UpdateOptions();
string originalRecord = ""; // Buffer with the original record content (only necessary for use with optimistic lock control)
DATAFORMAT_TYPE inputStringType = DATAFORMAT_TYPE.MV;
DATAFORMAT_TYPE outputStringType = DATAFORMAT_TYPE.MV;
string result = LinkarClt.Update_Text(crdOpt, filename, recordId, inputData, updateOptions, originalRecord, inputStringType, 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 = "1"
Dim inputData As String = "..." 'Buffer with the content of record to be update
Dim updateOptions As UpdateOptions = New UpdateOptions
Dim originalRecord As String = "" 'Buffer with the original record content (only necessary for use with optimistic lock control)
Dim inputStringType As DATAFORMAT_TYPE = DATAFORMAT_TYPE.MV
Dim outputStringType As DATAFORMAT_TYPE = DATAFORMAT_TYPE.MV
Dim result As String = LinkarClt.Update_Text(crdOpt, filename, recordId, inputData, updateOptions, originalRecord, inputStringType, outputStringType)

Reference

LinkarClt Class

Update_Text Overload

LinkarClient Namespace

LinkarCltAddLanguageSpecificTextSet("LST48A6A2E4_0?cpp=::|nu=.");Update_Text Method (CredentialsOptions, String, String, String, UpdateOptions, String, DATAFORMAT_TYPE, DATAFORMATCRU_TYPE, String, Int32)

Parameters

Return Value

Reference

LinkarCltUpdate_Text Method (CredentialsOptions, String, String, String, UpdateOptions, String, DATAFORMAT_TYPE, DATAFORMATCRU_TYPE, String, Int32)