LinkarCltRead_Text Method (CredentialsOptions, String, String, String, ReadOptions, DATAFORMATCRU_TYPE, String, Int32)

Reads one or several records of a file in 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 Read_Text(
	CredentialsOptions credentialsOptions,
	string filename,
	string recordIds,
	string dictClause = "",
	ReadOptions readOptions = null,
	DATAFORMATCRU_TYPE outputStringType = DATAFORMATCRU_TYPE.MV,
	string customVars = "",
	int receiveTimeout = 0
)

Public Shared Function Read_Text ( 
	credentialsOptions As CredentialsOptions,
	filename As String,
	recordIds As String,
	Optional dictClause As String = "",
	Optional readOptions As ReadOptions = Nothing,
	Optional outputStringType As DATAFORMATCRU_TYPE = DATAFORMATCRU_TYPE.MV,
	Optional customVars As String = "",
	Optional receiveTimeout As Integer = 0
) As String

public:
static String^ Read_Text(
	CredentialsOptions^ credentialsOptions, 
	String^ filename, 
	String^ recordIds, 
	String^ dictClause = L"", 
	ReadOptions^ readOptions = nullptr, 
	DATAFORMATCRU_TYPE outputStringType = DATAFORMATCRU_TYPE::MV, 
	String^ customVars = L"", 
	int receiveTimeout = 0
)

static member Read_Text : 
        credentialsOptions : CredentialsOptions * 
        filename : string * 
        recordIds : string * 
        ?dictClause : string * 
        ?readOptions : ReadOptions * 
        ?outputStringType : DATAFORMATCRU_TYPE * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _dictClause = defaultArg dictClause ""
        let _readOptions = defaultArg readOptions null
        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 to read.
recordIds: Type: SystemString
It's the records codes list to read, separated by the Record Separator character (30).
dictClause (Optional): Type: SystemString
List of dictionaries to read, separated by space. If dictionaries are not indicated the function will read the complete buffer.
readOptions (Optional): Type: LinkarCommonReadOptions
Object that defines the different reading options of the Function: Calculated, dictClause, conversion, formatSpec, originalRecords.
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 dictClause = "";
ReadOptions readOptions = new ReadOptions();
DATAFORMAT_TYPE outputStringType = DATAFORMAT_TYPE.MV;
string result = LinkarClt.Read_Text(crdOpt, filename, recordId, dictClause, readOptions, 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 dictClause As String = ""
Dim readOptions As ReadOptions = New ReadOptions
Dim outputStringType As DATAFORMAT_TYPE = DATAFORMAT_TYPE.MV
Dim result As String = LinkarClt.Read_Text(crdOpt, filename, recordId, dictClause, readOptions, outputStringType)

Reference

LinkarClt Class

Read_Text Overload

LinkarClient Namespace

LinkarCltAddLanguageSpecificTextSet("LST3250E098_0?cpp=::|nu=.");Read_Text Method (CredentialsOptions, String, String, String, ReadOptions, DATAFORMATCRU_TYPE, String, Int32)

Parameters

Return Value

Reference

LinkarCltRead_Text Method (CredentialsOptions, String, String, String, ReadOptions, DATAFORMATCRU_TYPE, String, Int32)