FunctionsRead Method

Linkar Framework for .NET and Core

Reads one or several records of a file, synchronously only, with MV input and output format.

Namespace: Linkar.Functions.Direct.MV
Assembly: Linkar.Functions.Direct.MV (in Linkar.Functions.Direct.MV.dll) Version: 2.3.1

Syntax

C++

Copy

public static string Read(
	CredentialOptions credentialOptions,
	string filename,
	string recordIds,
	string dictionaries = "",
	ReadOptions readOptions = null,
	string customVars = "",
	int receiveTimeout = 0
)

Public Shared Function Read ( 
	credentialOptions As CredentialOptions,
	filename As String,
	recordIds As String,
	Optional dictionaries As String = "",
	Optional readOptions As ReadOptions = Nothing,
	Optional customVars As String = "",
	Optional receiveTimeout As Integer = 0
) As String

public:
static String^ Read(
	CredentialOptions^ credentialOptions, 
	String^ filename, 
	String^ recordIds, 
	String^ dictionaries = L"", 
	ReadOptions^ readOptions = nullptr, 
	String^ customVars = L"", 
	int receiveTimeout = 0
)

static member Read : 
        credentialOptions : CredentialOptions * 
        filename : string * 
        recordIds : string * 
        ?dictionaries : string * 
        ?readOptions : ReadOptions * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _dictionaries = defaultArg dictionaries ""
        let _readOptions = defaultArg readOptions null
        let _customVars = defaultArg customVars ""
        let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> string

Parameters

credentialOptions CredentialOptions: Object with data necessary to access the Linkar Server: Username, Password, EntryPoint, Language, FreeText.
filename String: File name to read.
recordIds String: A list of item IDs to read, separated by the Record Separator character (30). Use StringFunctions.ComposeRecordIds to compose this string
dictionaries String (Optional): List of dictionaries to read, separated by space. If this list is not set, all fields are returned. You may use the format LKFLDx where x is the attribute number.
readOptions ReadOptions (Optional): Object that defines the different reading options of the Function: Calculated, dictClause, conversion, formatSpec, originalRecords.
customVars String (Optional): Free text sent to the database allows management of additional behaviours in SUB.LK.MAIN.CONTROL.CUSTOM, which is called when this parameter is set.
receiveTimeout Int32 (Optional): Maximum time in seconds that the client will wait for a response from the server. Default = 0 to wait indefinitely.

Return Value

String
The results of the operation.

Example

C++

Copy

using Linkar;
using Linkar.Functions.Direct.MV;

class Test
   {
       public string MyRead()
       {
           string result = "";
           try
           {
               CredentialOptions credentials = new CredentialOptions("127.0.0.1", "EPNAME", 11300, "admin", "admin");
               ReadOptions options = new ReadOptions(true);
               result = Functions.Read(credentials, "LK.CUSTOMERS", "2", "", options);
           }
           catch (Exception ex)
           {
               string error = ex.Message;
               // Do something
           }
           return result;
       }
   }

Imports Linkar
Imports Linkar.Functions.Direct.MV

Class Test

    Public Function MyRead() As String
        Dim result As String = ""

        Try
            Dim credentials As CredentialOptions = New CredentialOptions("127.0.0.1", "EPNAME", 11300, "admin", "admin")
            Dim options As ReadOptions = New ReadOptions(True);
            result = Functions.Read(credentials, "LK.CUSTOMERS", "2", "", options)            
        Catch ex As Exception

            Dim[error] As String = ex.Message
            ' Do something
        End Try

        Return result
  End Function
End Class

Reference

Functions Class

Linkar.Functions.Direct.MV Namespace