FunctionsLkPropertiesAsync Method

Linkar Framework for .NET and Core

Returns the Schema properties list defined in Linkar Schemas or the file dictionaries, in a asynchronous way with TABLE output format.

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

Syntax

C++

Copy

public static Task<string> LkPropertiesAsync(
	CredentialOptions credentialOptions,
	string filename,
	LkPropertiesOptions lkPropertiesOptions = null,
	string customVars = "",
	int receiveTimeout = 0
)

Public Shared Function LkPropertiesAsync ( 
	credentialOptions As CredentialOptions,
	filename As String,
	Optional lkPropertiesOptions As LkPropertiesOptions = Nothing,
	Optional customVars As String = "",
	Optional receiveTimeout As Integer = 0
) As Task(Of String)

public:
static Task<String^>^ LkPropertiesAsync(
	CredentialOptions^ credentialOptions, 
	String^ filename, 
	LkPropertiesOptions^ lkPropertiesOptions = nullptr, 
	String^ customVars = L"", 
	int receiveTimeout = 0
)

static member LkPropertiesAsync : 
        credentialOptions : CredentialOptions * 
        filename : string * 
        ?lkPropertiesOptions : LkPropertiesOptions * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _lkPropertiesOptions = defaultArg lkPropertiesOptions null
        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 LkProperties
lkPropertiesOptions LkPropertiesOptions (Optional): This object defines the different options in base of the asked Schema Type: LKSCHEMAS, SQLMODE o DICTIONARIES.
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.

Remarks

TABLE output format uses the defined control characters in EntryPoints Parameters Table Row Separator and Column Row Separator.

By default:

TAB char (9) for columns.
VT char (11) for rows.

Example

C++

Copy

using Linkar;
using Linkar.Functions.Direct.TABLE;

class Test
    {
        public string MyLkProperties()
        {
            string result = "";
            try
            {
                CredentialOptions credentials = new CredentialOptions("127.0.0.1", "EPNAME", 11300, "admin", "admin");
                LkPropertiesOptions options = new LkPropertiesOptions(RowHeaders.TYPE.MAINLABEL, false, false, false);
                result = Functions.LkPropertiesAsync(credentials, "LK.CUSTOMERS", options).Result;
            }
            catch (Exception ex)
            {
                string error = ex.Message;
                // Do something
            }
            return result;
        }
    }

Imports Linkar
Imports Linkar.Functions.Direct.TABLE

Class Test

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

        Try
            Dim credentials As CredentialOptions = New CredentialOptions("127.0.0.1", "EPNAME", 11300, "admin", "admin")

            Dim options As LkPropertiesOptions = New LkPropertiesOptions(RowHeaders.TYPE.MAINLABEL, False, False, False);
            result = Functions.LkPropertiesAsync(credentials, "LK.CUSTOMERS",options).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.TABLE Namespace