Click or drag to resize

FunctionsFormatAsync Method

Linkar Framework for .NET and Core


Returns the result of executing the FMT function in a expressions list in the Database, 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
public static Task<string> FormatAsync(
	CredentialOptions credentialOptions,
	string expression,
	string formatSpec,
	string customVars = "",
	int receiveTimeout = 0
)

Parameters

credentialOptions  CredentialOptions
Object with data necessary to access the Linkar Server: Username, Password, EntryPoint, Language, FreeText.
expression  String
The data or expression to format. If multiple values are present, the operation will be performed individually on all values in the expression.
formatSpec  String
Specified format
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.XML;

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

                result = Functions.FormatAsync(credentials, "1þ2", "R#10").Result;
            }
            catch (Exception ex)
            {
                string error = ex.Message;
                // Do something
            }
            return result;
        }
    }
See Also