| LinkarClientSubroutine Method |
Linkar Framework for .NET and Core
Executes a subroutine, synchronously only.
Namespace: Linkar.Functions.PersistentAssembly: Linkar.Functions.Persistent (in Linkar.Functions.Persistent.dll) Version: 2.3.1
Syntax public string Subroutine(
string subroutineName,
int argsNumber,
string arguments,
DATAFORMAT_TYPE inputFormat = DATAFORMAT_TYPE.MV,
DATAFORMAT_TYPE outputFormat = DATAFORMAT_TYPE.MV,
string customVars = "",
int receiveTimeout = 0
)
Public Function Subroutine (
subroutineName As String,
argsNumber As Integer,
arguments As String,
Optional inputFormat As DATAFORMAT_TYPE = DATAFORMAT_TYPE.MV,
Optional outputFormat As DATAFORMAT_TYPE = DATAFORMAT_TYPE.MV,
Optional customVars As String = "",
Optional receiveTimeout As Integer = 0
) As String
public:
String^ Subroutine(
String^ subroutineName,
int argsNumber,
String^ arguments,
DATAFORMAT_TYPE inputFormat = DATAFORMAT_TYPE::MV,
DATAFORMAT_TYPE outputFormat = DATAFORMAT_TYPE::MV,
String^ customVars = L"",
int receiveTimeout = 0
)
member Subroutine :
subroutineName : string *
argsNumber : int *
arguments : string *
?inputFormat : DATAFORMAT_TYPE *
?outputFormat : DATAFORMAT_TYPE *
?customVars : string *
?receiveTimeout : int
(* Defaults:
let _inputFormat = defaultArg inputFormat DATAFORMAT_TYPE.MV
let _outputFormat = defaultArg outputFormat DATAFORMAT_TYPE.MV
let _customVars = defaultArg customVars ""
let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> string
Parameters
- subroutineName String
- Name of BASIC subroutine to execute.
- argsNumber Int32
- Number of arguments
- arguments String
- The subroutine arguments list. Each argument is a substring separated with the ASCII char DC4 (20).
- inputFormat DATAFORMAT_TYPE (Optional)
- Indicates in what format you wish to send the subroutine arguments: MV, XML or JSON.
- outputFormat DATAFORMAT_TYPE (Optional)
- Indicates in what format you want to receive the data resulting from the operation: MV, XML or JSON.
- 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
StringThe results of the operation.
See Also