| LinkarCltFormatAsync Method (LinkarCltOperationAsyncCallbackLkData, String, String, String, Int32) |
Returns the result of executing the FMT function in a expressions list in the Database, in a Asynchronous way.
Persistent 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 public void FormatAsync(
OperationAsyncCallbackLkData cmdFormatFinished,
string expression,
string formatSpec,
string customVars = "",
int receiveTimeout = -1
)
Public Sub FormatAsync (
cmdFormatFinished As OperationAsyncCallbackLkData,
expression As String,
formatSpec As String,
Optional customVars As String = "",
Optional receiveTimeout As Integer = -1
)
public:
void FormatAsync(
OperationAsyncCallbackLkData^ cmdFormatFinished,
String^ expression,
String^ formatSpec,
String^ customVars = L"",
int receiveTimeout = -1
)
member FormatAsync :
cmdFormatFinished : OperationAsyncCallbackLkData *
expression : string *
formatSpec : string *
?customVars : string *
?receiveTimeout : int
(* Defaults:
let _customVars = defaultArg customVars ""
let _receiveTimeout = defaultArg receiveTimeout -1
*)
-> unit
Parameters
- cmdFormatFinished
- Type: LinkarClientOperationAsyncCallbackLkData
Return type in asynchronous methods - 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 LinkarClt lkClt = new LinkarClt();
CredentialsOptions crdOpt = new CredentialsOptions("127.0.0.1", 11300, "admin", "admin", "ENTRYPOINT");
lkClt.Login(crdOpt);
string expression = "1";
string formatSpec = "R#10";
lkClt.FormatAsync(new LinkarClt.OperationAsyncCallbackLkData(FormatAsyncFinished), expression, formatSpec);
Dim lkClt As LinkarClt = New LinkarClt
Dim crdOpt As CredentialsOptions = New CredentialsOptions("127.0.0.1", 11300, "admin", "admin", "ENTRYPOINT")
lkClt.Login(crdOpt)
Dim expression As String = "1"
Dim formatSpec As String = "R#10"
lkClt.FormatAsync(New LinkarClt.OperationAsyncCallbackLkData(FormatAsyncFinished), expression, formatSpec)
No code example is currently available or this language may not be supported.
No code example is currently available or this language may not be supported.
See Also