FunctionsReadAsync Method

Linkar Framework .NET (Core and Framework)

Reads one or several records of a file in a asynchronous way with XML output format.

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

Syntax

C++

Copy

public static Task<string> ReadAsync(
	CredentialOptions credentialOptions,
	string filename,
	string records,
	string dictionaries = "",
	ReadOptions readOptions = null,
	FunctionsXML_FORMAT xmlFormat = FunctionsXML_FORMAT.XML,
	string customVars = "",
	int receiveTimeout = 0
)

Public Shared Function ReadAsync ( 
	credentialOptions As CredentialOptions,
	filename As String,
	records As String,
	Optional dictionaries As String = "",
	Optional readOptions As ReadOptions = Nothing,
	Optional xmlFormat As FunctionsXML_FORMAT = FunctionsXML_FORMAT.XML,
	Optional customVars As String = "",
	Optional receiveTimeout As Integer = 0
) As Task(Of String)

public:
static Task<String^>^ ReadAsync(
	CredentialOptions^ credentialOptions, 
	String^ filename, 
	String^ records, 
	String^ dictionaries = L"", 
	ReadOptions^ readOptions = nullptr, 
	FunctionsXML_FORMAT xmlFormat = FunctionsXML_FORMAT::XML, 
	String^ customVars = L"", 
	int receiveTimeout = 0
)

static member ReadAsync : 
        credentialOptions : CredentialOptions * 
        filename : string * 
        records : string * 
        ?dictionaries : string * 
        ?readOptions : ReadOptions * 
        ?xmlFormat : FunctionsXML_FORMAT * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _dictionaries = defaultArg dictionaries ""
        let _readOptions = defaultArg readOptions null
        let _xmlFormat = defaultArg xmlFormat FunctionsXML_FORMAT.XML
        let _customVars = defaultArg customVars ""
        let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> Task<string>

Parameters

credentialOptions CredentialOptions: Object with data necessary to access the Linkar Server: Username, Password, EntryPoint, Language, FreeText.
filename String: File name to read.
records String: A list of item IDs to read.
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.
xmlFormat FunctionsXML_FORMAT (Optional): Different XML output formats.
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

TaskString
The results of the operation.

Example

C++

Copy

using Linkar;
using Linkar.Functions.Direct.XML;

class Test
    {
        public string MyRead()
        {
            string result = "";
            try
            {
                CredentialOptions credentials = new CredentialOptions("127.0.0.1", "EPNAME", 11300, "admin", "admin");

                result = Functions.ReadAsync(credentials, "LK.CUSTOMERS",
                    "<?xml version=\"1.0\" encoding=\"utf-16\"?>" + 
                    "<LINKAR>" +
                    "  <RECORDS>" +
                    "    <RECORD>" +
                    "      <LKITEMID>2</LKITEMID>" +
                    "    </RECORD>" +
                    "  </RECORDS>" +
                    "</LINKAR>",
                "", null, XML_FORMAT.XML).Result;
            }
            catch (Exception ex)
            {
                string error = ex.Message;
                // Do something
            }
            return result;
        }
    }

Imports Linkar
Imports Linkar.Functions.Direct.XML

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")

            result = Functions.ReadAsync(credentials, "LK.CUSTOMERS",
                    "<?xml version=\"1.0\" encoding=\"utf-16\"?>" + 
                    "<LINKAR>" +
                    "  <RECORDS>" +
                    "    <RECORD>" +
                    "      <LKITEMID>2</LKITEMID>" +
                    "    </RECORD>" +
                    "  </RECORDS>" +
                    "</LINKAR>",
            "", null, XML_FORMAT.XML).Result
        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.XML Namespace