Click or drag to resize

LinkarClientLkSchemasAsync Method

Linkar Framework for .NET and Core


Returns a list of all the Schemas defined in Linkar Schemas, or the EntryPoint account data files, in a asynchronous way with TABLE output format.

Namespace: Linkar.Functions.Persistent.TABLE
Assembly: Linkar.Functions.Persistent.TABLE (in Linkar.Functions.Persistent.TABLE.dll) Version: 2.3.1
Syntax
public Task<string> LkSchemasAsync(
	LkSchemasOptions lkSchemasOptions = null,
	string customVars = "",
	int receiveTimeout = 0
)

Parameters

lkSchemasOptions  LkSchemasOptions  (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
using Linkar;
using Linkar.Functions.Persistent.TABLE;

class Test
    {
        public string MyLkSchemas()
        {
            string result = "";
            try
            {
                CredentialOptions credentials = new CredentialOptions("127.0.0.1", "EPNAME", 11300, "admin", "admin");
                LinkarClient client = new LinkarClient();
                client.Login(credentials);
                LkSchemasOptions options = new LkSchemasOptions(RowHeaders.TYPE.MAINLABEL, false, false);
                result = client.LkSchemasAsync(options).Result;
                client.Logout();
            }
            catch (Exception ex)
            {
                string error = ex.Message;
                // Do something
            }
            return result;
        }
    }
See Also