LinkarCltRunSubroutineAsync_Text Method (LinkarCltOperationAsyncCallbackString, String, String, DATAFORMAT_TYPE, String, Int32)

Executes a subroutine, 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

C++

Copy

public void RunSubroutineAsync_Text(
	OperationAsyncCallbackString cmdRunSubroutineFinished,
	string subroutineName,
	string[] lstArguments,
	DATAFORMAT_TYPE outputStringType = DATAFORMAT_TYPE.MV,
	string customVars = "",
	int receiveTimeout = -1
)

Public Sub RunSubroutineAsync_Text ( 
	cmdRunSubroutineFinished As OperationAsyncCallbackString,
	subroutineName As String,
	lstArguments As String(),
	Optional outputStringType As DATAFORMAT_TYPE = DATAFORMAT_TYPE.MV,
	Optional customVars As String = "",
	Optional receiveTimeout As Integer = -1
)

public:
void RunSubroutineAsync_Text(
	OperationAsyncCallbackString^ cmdRunSubroutineFinished, 
	String^ subroutineName, 
	array<String^>^ lstArguments, 
	DATAFORMAT_TYPE outputStringType = DATAFORMAT_TYPE::MV, 
	String^ customVars = L"", 
	int receiveTimeout = -1
)

member RunSubroutineAsync_Text : 
        cmdRunSubroutineFinished : OperationAsyncCallbackString * 
        subroutineName : string * 
        lstArguments : string[] * 
        ?outputStringType : DATAFORMAT_TYPE * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _outputStringType = defaultArg outputStringType DATAFORMAT_TYPE.MV
        let _customVars = defaultArg customVars ""
        let _receiveTimeout = defaultArg receiveTimeout -1
*)
-> unit

Parameters

cmdRunSubroutineFinished: Type: LinkarClientOperationAsyncCallbackString
Return type in asynchronous methods.
subroutineName: Type: SystemString
Subroutine name you want to execute.
lstArguments: Type: SystemString
The subroutine arguments list.
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

LinkarClt lkClt = new LinkarClt();
CredentialsOptions crdOpt = new CredentialsOptions("127.0.0.1", 11300, "admin", "admin", "ENTRYPOINT");
lkClt.Login(crdOpt);

string subroutineName = "SUB.DEMOLINKAR";
string[] lstArgs = new string[] { "0", "qwerty", "" };
DATAFORMAT_TYPE outputStringType = DATAFORMAT_TYPE.MV;
lkClt.RunSubroutineAsync_Text(new LinkarClt.OperationAsyncCallbackString(RunSubroutineAsyncFinished), subroutineName, lstArgs, outputStringType);

Dim lkClt As LinkarClt = New LinkarClt
Dim crdOpt As CredentialsOptions = New CredentialsOptions("127.0.0.1", 11300, "admin", "admin", "ENTRYPOINT")
lkClt.Login(crdOpt)

Dim subroutineName As String = "SUB.DEMOLINKAR"
Dim lstArgs As String() = New String() {"0", "qwerty", ""}
Dim outputStringType As DATAFORMAT_TYPE = DATAFORMAT_TYPE.MV
lkClt.RunSubroutineAsync_Text(New LinkarClt.OperationAsyncCallbackString(RunSubroutineAsyncFinished), subroutineName, lstArguments, outputStringType)

Reference

LinkarClt Class

RunSubroutineAsync_Text Overload

LinkarClient Namespace