Click or drag to resize

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 MV output format.

Namespace: Linkar.Functions.Direct.MV
Assembly: Linkar.Functions.Direct.MV (in Linkar.Functions.Direct.MV.dll) Version: 2.3.1
Syntax
public static Task<string> LkPropertiesAsync(
	CredentialOptions credentialOptions,
	string filename,
	LkPropertiesOptions lkPropertiesOptions = null,
	string customVars = "",
	int receiveTimeout = 0
)

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.
Example
using Linkar;
using Linkar.Functions.Direct.MV;

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;
        }
    }
See Also