 | LinkarCltFormat Method |
Returns the result of executing the FMT function in a expressions list in the Database, in a Synchronous way.
Persistent Method.
Namespace:
LinkarClient
Assembly:
LinkarClientCOM (in LinkarClientCOM.dll) Version: 2.1.0.0 (2.1.0.0)
Syntaxpublic LkData Format(
string expression,
string formatSpec,
string customVars = "",
int receiveTimeout = -1
)
Public Function Format (
expression As String,
formatSpec As String,
Optional customVars As String = "",
Optional receiveTimeout As Integer = -1
) As LkData
public:
LkData^ Format(
String^ expression,
String^ formatSpec,
String^ customVars = L"",
int receiveTimeout = -1
)
member Format :
expression : string *
formatSpec : string *
?customVars : string *
?receiveTimeout : int
(* Defaults:
let _customVars = defaultArg customVars ""
let _receiveTimeout = defaultArg receiveTimeout -1
*)
-> LkData
Parameters
- 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).
Return Value
Type:
LkDataRetorna un objeto de tipo
LkData con los resultados de la operación.
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";
LkData lkDataFormat = lkClt.Format(formatType, 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"
Dim lkDataFormat As LkData = lkClt.Format(formatType, 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 
