Click or drag to resize

LinkarCltRunSubroutine_Text Method (String, String, DATAFORMAT_TYPE, String, Int32)

Executes a subroutine, in a Synchronous 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
public string RunSubroutine_Text(
	string subroutineName,
	string[] lstArguments,
	DATAFORMAT_TYPE outputStringType = DATAFORMAT_TYPE.MV,
	string customVars = "",
	int receiveTimeout = -1
)

Parameters

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).

Return Value

Type: String
Returns an object of type LkString with the results of the operation.
Exceptions
ExceptionCondition
SocketException

Thrown when there are communication problems between LINKAR Client and LINKAR Server

LkException

Thrown when there are errors in LINKAR Client or LINKAR Server

Examples
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;
string result = lkClt.RunSubroutine_Text(subroutineName, lstArgs, outputStringType);
See Also