LinkarCltRunSubroutineAsync Method (LinkarCltOperationAsyncCallbackLkData, CredentialsOptions, String, String, String, Int32)

Executes a subroutine, 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 RunSubroutineAsync(
	OperationAsyncCallbackLkData cmdRunSubroutineFinished,
	CredentialsOptions credentialsOptions,
	string subroutineName,
	string[] lstArguments,
	string customVars = "",
	int receiveTimeout = 0
)

Public Shared Sub RunSubroutineAsync ( 
	cmdRunSubroutineFinished As OperationAsyncCallbackLkData,
	credentialsOptions As CredentialsOptions,
	subroutineName As String,
	lstArguments As String(),
	Optional customVars As String = "",
	Optional receiveTimeout As Integer = 0
)

public:
static void RunSubroutineAsync(
	OperationAsyncCallbackLkData^ cmdRunSubroutineFinished, 
	CredentialsOptions^ credentialsOptions, 
	String^ subroutineName, 
	array<String^>^ lstArguments, 
	String^ customVars = L"", 
	int receiveTimeout = 0
)

static member RunSubroutineAsync : 
        cmdRunSubroutineFinished : OperationAsyncCallbackLkData * 
        credentialsOptions : CredentialsOptions * 
        subroutineName : string * 
        lstArguments : string[] * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _customVars = defaultArg customVars ""
        let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> unit

Parameters

cmdRunSubroutineFinished: Type: LinkarClientOperationAsyncCallbackLkData
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.
subroutineName: Type: SystemString
Subroutine name you want to execute.
lstArguments: Type: SystemString
The subroutine arguments list.
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 subroutineName = "SUB.DEMOLINKAR";
string[] lstArgs = new string[] { "0", "qwerty", "" };
LinkarClt.RunSubroutineAsync(new LinkarClt.OperationAsyncCallbackLkData(RunSubroutineAsyncFinished), crdOpt, subroutineName, lstArgs);

Dim crdOpt As CredentialsOptions = New CredentialsOptions("127.0.0.1", 11300, "admin", "admin", "ENTRYPOINT")

Dim subroutineName As String = "SUB.DEMOLINKAR"
Dim lstArgs As String() = New String() {"0", "qwerty", ""}
LinkarClt.RunSubroutineAsync(New LinkarClt.OperationAsyncCallbackLkData(RunSubroutineAsyncFinished), crdOpt, subroutineName, lstArgs)

Reference

LinkarClt Class

RunSubroutineAsync Overload

LinkarClient Namespace