LinkarCltFormatAsync_Text Method (LinkarCltOperationAsyncCallbackString, CredentialsOptions, String, String, DATAFORMAT_TYPE, 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_Text(
	OperationAsyncCallbackString cmdFormatFinished,
	CredentialsOptions credentialsOptions,
	string expression,
	string formatSpec,
	DATAFORMAT_TYPE outputStringType = DATAFORMAT_TYPE.MV,
	string customVars = "",
	int receiveTimeout = 0
)

Public Shared Sub FormatAsync_Text ( 
	cmdFormatFinished As OperationAsyncCallbackString,
	credentialsOptions As CredentialsOptions,
	expression As String,
	formatSpec As String,
	Optional outputStringType As DATAFORMAT_TYPE = DATAFORMAT_TYPE.MV,
	Optional customVars As String = "",
	Optional receiveTimeout As Integer = 0
)

public:
static void FormatAsync_Text(
	OperationAsyncCallbackString^ cmdFormatFinished, 
	CredentialsOptions^ credentialsOptions, 
	String^ expression, 
	String^ formatSpec, 
	DATAFORMAT_TYPE outputStringType = DATAFORMAT_TYPE::MV, 
	String^ customVars = L"", 
	int receiveTimeout = 0
)

static member FormatAsync_Text : 
        cmdFormatFinished : OperationAsyncCallbackString * 
        credentialsOptions : CredentialsOptions * 
        expression : string * 
        formatSpec : string * 
        ?outputStringType : DATAFORMAT_TYPE * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _outputStringType = defaultArg outputStringType DATAFORMAT_TYPE.MV
        let _customVars = defaultArg customVars ""
        let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> unit

Parameters

cmdFormatFinished: Type: LinkarClientOperationAsyncCallbackString
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
outputStringType (Optional): Type: LinkarCommonDATAFORMAT_TYPE
Indicates in what format you want to receive the data resulting from the operation: MV, XML or JSON.
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";
DATAFORMAT_TYPE outputStringType = DATAFORMAT_TYPE.MV;
LinkarClt.FormatAsync_Text(new LinkarClt.OperationAsyncCallbackString(FormatAsyncFinished), crdOpt, expression, formatSpec, outputStringType);

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"
Dim outputStringType As DATAFORMAT_TYPE = DATAFORMAT_TYPE.MV
LinkarClt.FormatAsync_Text(New LinkarClt.OperationAsyncCallbackString(FormatAsyncFinished), crdOpt, expression, formatSpec, outputStringType)

Reference

LinkarClt Class

FormatAsync_Text Overload

LinkarClient Namespace

LinkarCltAddLanguageSpecificTextSet("LSTCB142019_0?cpp=::|nu=.");FormatAsync_Text Method (LinkarCltAddLanguageSpecificTextSet("LSTCB142019_1?cpp=::|nu=.");OperationAsyncCallbackString, CredentialsOptions, String, String, DATAFORMAT_TYPE, String, Int32)

Parameters

Reference

LinkarCltFormatAsync_Text Method (LinkarCltOperationAsyncCallbackString, CredentialsOptions, String, String, DATAFORMAT_TYPE, String, Int32)