| FunctionsFormatAsync Method |
Linkar Framework .NET (Core and Framework)
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.XMLAssembly: 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
)
Public Shared Function FormatAsync (
credentialOptions As CredentialOptions,
expression As String,
formatSpec As String,
Optional customVars As String = "",
Optional receiveTimeout As Integer = 0
) As Task(Of String)
public:
static Task<String^>^ FormatAsync(
CredentialOptions^ credentialOptions,
String^ expression,
String^ formatSpec,
String^ customVars = L"",
int receiveTimeout = 0
)
static member FormatAsync :
credentialOptions : CredentialOptions *
expression : string *
formatSpec : string *
?customVars : string *
?receiveTimeout : int
(* Defaults:
let _customVars = defaultArg customVars ""
let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> Task<string>
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
TaskStringThe 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;
}
return result;
}
}
Imports Linkar
Imports Linkar.Functions.Direct.XML
Class Test
Public Function MyFormat() As String
Dim result As String = ""
Try
Dim credentials As CredentialOptions = New CredentialOptions("127.0.0.1", "EPNAME", 11300, "admin", "admin")
result = Functions.FormatAsync(credentials, "1þ2","R#10").Result
Catch ex As Exception
Dim[error] As String = ex.Message
End Try
Return result
End Function
End Class
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