LinkarCltNew_Text Method (CredentialsOptions, String, String, String, NewOptions, DATAFORMAT_TYPE, DATAFORMATCRU_TYPE, String, Int32)

Creates 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 New_Text(
	CredentialsOptions credentialsOptions,
	string filename,
	string recordIds,
	string records,
	NewOptions newOptions = null,
	DATAFORMAT_TYPE inputStringType = DATAFORMAT_TYPE.MV,
	DATAFORMATCRU_TYPE outputStringType = DATAFORMATCRU_TYPE.MV,
	string customVars = "",
	int receiveTimeout = 0
)

Public Shared Function New_Text ( 
	credentialsOptions As CredentialsOptions,
	filename As String,
	recordIds As String,
	records As String,
	Optional newOptions As NewOptions = Nothing,
	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^ New_Text(
	CredentialsOptions^ credentialsOptions, 
	String^ filename, 
	String^ recordIds, 
	String^ records, 
	NewOptions^ newOptions = nullptr, 
	DATAFORMAT_TYPE inputStringType = DATAFORMAT_TYPE::MV, 
	DATAFORMATCRU_TYPE outputStringType = DATAFORMATCRU_TYPE::MV, 
	String^ customVars = L"", 
	int receiveTimeout = 0
)

static member New_Text : 
        credentialsOptions : CredentialsOptions * 
        filename : string * 
        recordIds : string * 
        records : string * 
        ?newOptions : NewOptions * 
        ?inputStringType : DATAFORMAT_TYPE * 
        ?outputStringType : DATAFORMATCRU_TYPE * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _newOptions = defaultArg newOptions null
        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 write, separated by the Record Separator character (30). In case they are empty, you will have to use one of the newOptions options.
records: Type: SystemString
Are the records you want to write, separated by the Record Separator character (30).
newOptions (Optional): Type: LinkarCommonNewOptions
Object that defines the following writing options of the Function: recordIdType, readAfter, calculated, dictionaries, conversion, formatSpec, originalRecords.
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 = "101";
string inputData = "..."; // Buffer with the content of record to be new
NewOptions newOptions = new NewOptions();
DATAFORMAT_TYPE inputStringType = DATAFORMAT_TYPE.MV;
DATAFORMAT_TYPE outputStringType = DATAFORMAT_TYPE.MV;
string result = LinkarClt.New_Text(crdOpt, filename, recordId, inputData, newOptions, 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 = "101"
Dim inputData As String = "..." 'Buffer with the content of record to be new
Dim newOptions As NewOptions = New NewOptions
Dim inputStringType As DATAFORMAT_TYPE = DATAFORMAT_TYPE.MV
Dim outputStringType As DATAFORMAT_TYPE = DATAFORMAT_TYPE.MV
Dim result As String = LinkarClt.New_Text(crdOpt, filename, recordId, inputData, newOptions, inputStringType, outputStringType)

Reference

LinkarClt Class

New_Text Overload

LinkarClient Namespace

LinkarCltAddLanguageSpecificTextSet("LST65717F13_0?cpp=::|nu=.");New_Text Method (CredentialsOptions, String, String, String, NewOptions, DATAFORMAT_TYPE, DATAFORMATCRU_TYPE, String, Int32)

Parameters

Return Value

Reference

LinkarCltNew_Text Method (CredentialsOptions, String, String, String, NewOptions, DATAFORMAT_TYPE, DATAFORMATCRU_TYPE, String, Int32)