LinkarCltFormatAsync Method (LinkarCltOperationAsyncCallbackLkData, CredentialsOptions, String, String, String, Int32)

Returns the result of executing the FMT function in a expressions list in the Database, in a Asynchronous way.

Direct Method.

Namespace: LinkarClient
Assemblies:   LinkarClientCore (in LinkarClientCore.dll) Version: 2.1.0.0
  LinkarClientMono (in LinkarClientMono.dll) Version: 2.1.0.0 (2.1.0.0)
  LinkarClient (in LinkarClient.dll) Version: 2.1.0.0 (2.1.0.0)

Syntax

C++

Copy

public static void FormatAsync(
	OperationAsyncCallbackLkData cmdFormatFinished,
	CredentialsOptions credentialsOptions,
	string expression,
	string formatSpec,
	string customVars = "",
	int receiveTimeout = 0
)

Public Shared Sub FormatAsync ( 
	cmdFormatFinished As OperationAsyncCallbackLkData,
	credentialsOptions As CredentialsOptions,
	expression As String,
	formatSpec As String,
	Optional customVars As String = "",
	Optional receiveTimeout As Integer = 0
)

public:
static void FormatAsync(
	OperationAsyncCallbackLkData^ cmdFormatFinished, 
	CredentialsOptions^ credentialsOptions, 
	String^ expression, 
	String^ formatSpec, 
	String^ customVars = L"", 
	int receiveTimeout = 0
)

static member FormatAsync : 
        cmdFormatFinished : OperationAsyncCallbackLkData * 
        credentialsOptions : CredentialsOptions * 
        expression : string * 
        formatSpec : string * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _customVars = defaultArg customVars ""
        let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> unit

Parameters

cmdFormatFinished: Type: LinkarClientOperationAsyncCallbackLkData
Return type in asynchronous methods
credentialsOptions: Type: LinkarCommonCredentialsOptions
Object that defines the necessary data to access to the Linkar Server: Username, Password, EntryPoint, Language, FreeText.
expression: Type: SystemString
The data or expression to format. It can contain MV marks, in which case the conversion in each value will be executed according to the original MV mark.
formatSpec: Type: SystemString
Specified format
customVars (Optional): Type: SystemString
It's a free text that will travel until the database to make the admin being able to manage additional behaviours in the standard routine SUB.LK.MAIN.CONTROL.CUSTOM. This routine will be called if the argument has content.
receiveTimeout (Optional): Type: SystemInt32
It's the maximum time in seconds that the client will keep waiting the answer by the server. By default -1 (wait indefinitely).

Examples

C++

Copy

CredentialsOptions crdOpt = new CredentialsOptions("127.0.0.1", 11300, "admin", "admin", "ENTRYPOINT");

string expression = "1";
string formatSpec = "R#10";
LinkarClt.FormatAsync(new LinkarClt.OperationAsyncCallbackLkData(FormatAsyncFinished), crdOpt, expression, formatSpec);

Dim crdOpt As CredentialsOptions = New CredentialsOptions("127.0.0.1", 11300, "admin", "admin", "ENTRYPOINT")

Dim expression As String = "1"
Dim formatSpec As String = "R#10"
LinkarClt.FormatAsync(New LinkarClt.OperationAsyncCallbackLkData(FormatAsyncFinished), crdOpt, expression, formatSpec)

Reference

LinkarClt Class

FormatAsync Overload

LinkarClient Namespace

LinkarCltAddLanguageSpecificTextSet("LSTEB0B036F_0?cpp=::|nu=.");FormatAsync Method (LinkarCltAddLanguageSpecificTextSet("LSTEB0B036F_1?cpp=::|nu=.");OperationAsyncCallbackLkData, CredentialsOptions, String, String, String, Int32)

Parameters

Reference

LinkarCltFormatAsync Method (LinkarCltOperationAsyncCallbackLkData, CredentialsOptions, String, String, String, Int32)