LinkarCltRead Method (CredentialsOptions, String, String, String, ReadOptions, 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 LkData Read(
	CredentialsOptions credentialsOptions,
	string filename,
	string recordIds,
	string dictClause = "",
	ReadOptions readOptions = null,
	string customVars = "",
	int receiveTimeout = 0
)

Public Shared Function Read ( 
	credentialsOptions As CredentialsOptions,
	filename As String,
	recordIds As String,
	Optional dictClause As String = "",
	Optional readOptions As ReadOptions = Nothing,
	Optional customVars As String = "",
	Optional receiveTimeout As Integer = 0
) As LkData

public:
static LkData^ Read(
	CredentialsOptions^ credentialsOptions, 
	String^ filename, 
	String^ recordIds, 
	String^ dictClause = L"", 
	ReadOptions^ readOptions = nullptr, 
	String^ customVars = L"", 
	int receiveTimeout = 0
)

static member Read : 
        credentialsOptions : CredentialsOptions * 
        filename : string * 
        recordIds : string * 
        ?dictClause : string * 
        ?readOptions : ReadOptions * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _dictClause = defaultArg dictClause ""
        let _readOptions = defaultArg readOptions null
        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
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.
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 = "1";
string dictClause = "";
ReadOptions readOptions = new ReadOptions();
LkData lkDataRead = LinkarClt.Read(crdOpt, filename, recordId, dictClause, readOptions);

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 lkDataRead As LkData = LinkarClt.Read(crdOpt, filename, recordId, dictClause, readOptions)

Reference

LinkarClt Class

Read Overload

LinkarClient Namespace

LinkarCltAddLanguageSpecificTextSet("LST84A411B5_0?cpp=::|nu=.");Read Method (CredentialsOptions, String, String, String, ReadOptions, String, Int32)

Parameters

Return Value

Reference

LinkarCltRead Method (CredentialsOptions, String, String, String, ReadOptions, String, Int32)