FunctionsLkProperties Method

Linkar Framework for .NET and Core

Returns the Schema properties list defined in Linkar Schemas or the file dictionaries, synchronously only, with JSON output format.

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

Syntax

C++

Copy

public static string LkProperties(
	CredentialOptions credentialOptions,
	string filename,
	LkPropertiesOptions lkPropertiesOptions = null,
	FunctionsJSON_FORMAT outputFormat = FunctionsJSON_FORMAT.JSON,
	string customVars = "",
	int receiveTimeout = 0
)

Public Shared Function LkProperties ( 
	credentialOptions As CredentialOptions,
	filename As String,
	Optional lkPropertiesOptions As LkPropertiesOptions = Nothing,
	Optional outputFormat As FunctionsJSON_FORMAT = FunctionsJSON_FORMAT.JSON,
	Optional customVars As String = "",
	Optional receiveTimeout As Integer = 0
) As String

public:
static String^ LkProperties(
	CredentialOptions^ credentialOptions, 
	String^ filename, 
	LkPropertiesOptions^ lkPropertiesOptions = nullptr, 
	FunctionsJSON_FORMAT outputFormat = FunctionsJSON_FORMAT::JSON, 
	String^ customVars = L"", 
	int receiveTimeout = 0
)

static member LkProperties : 
        credentialOptions : CredentialOptions * 
        filename : string * 
        ?lkPropertiesOptions : LkPropertiesOptions * 
        ?outputFormat : FunctionsJSON_FORMAT * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _lkPropertiesOptions = defaultArg lkPropertiesOptions null
        let _outputFormat = defaultArg outputFormat FunctionsJSON_FORMAT.JSON
        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 LkProperties
lkPropertiesOptions LkPropertiesOptions (Optional): This object defines the different options in base of the asked Schema Type: LKSCHEMAS, SQLMODE o DICTIONARIES.
outputFormat FunctionsJSON_FORMAT (Optional): Indicates in what format you want to receive the data resulting from the operation: JSON, JSON_DICT or JSON_SCH.
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.JSON;

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.LkProperties(credentials, "LK.CUSTOMERS", options);
            }
            catch (Exception ex)
            {
                string error = ex.Message;
                // Do something
            }
            return result;
        }
    }

Imports Linkar
Imports Linkar.Functions.Direct.JSON

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.LkProperties(credentials, "LK.CUSTOMERS",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.JSON Namespace