| LinkarCltExecuteAsync_Text Method (LinkarCltOperationAsyncCallbackString, CredentialsOptions, String, DATAFORMAT_TYPE, String, Int32) |
Allows the execution of any command from 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 public static void ExecuteAsync_Text(
OperationAsyncCallbackString cmdExecuteFinished,
CredentialsOptions credentialsOptions,
string statement,
DATAFORMAT_TYPE outputStringType = DATAFORMAT_TYPE.MV,
string customVars = "",
int receiveTimeout = 0
)
Public Shared Sub ExecuteAsync_Text (
cmdExecuteFinished As OperationAsyncCallbackString,
credentialsOptions As CredentialsOptions,
statement As String,
Optional outputStringType As DATAFORMAT_TYPE = DATAFORMAT_TYPE.MV,
Optional customVars As String = "",
Optional receiveTimeout As Integer = 0
)
public:
static void ExecuteAsync_Text(
OperationAsyncCallbackString^ cmdExecuteFinished,
CredentialsOptions^ credentialsOptions,
String^ statement,
DATAFORMAT_TYPE outputStringType = DATAFORMAT_TYPE::MV,
String^ customVars = L"",
int receiveTimeout = 0
)
static member ExecuteAsync_Text :
cmdExecuteFinished : OperationAsyncCallbackString *
credentialsOptions : CredentialsOptions *
statement : 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
- cmdExecuteFinished
- 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.
- statement
- Type: SystemString
The command you want to execute in the Database. - 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 CredentialsOptions crdOpt = new CredentialsOptions("127.0.0.1", 11300, "admin", "admin", "ENTRYPOINT");
string statement = "WHO";
DATAFORMAT_TYPE outputStringType = DATAFORMAT_TYPE.MV;
LinkarClt.ExecuteAsync_Text(new LinkarClt.OperationAsyncCallbackString(ExecuteAsyncFinished), crdOpt, statement, outputStringType);
Dim crdOpt As CredentialsOptions = New CredentialsOptions("127.0.0.1", 11300, "admin", "admin", "ENTRYPOINT")
Dim statement As String = "WHO"
Dim outputStringType As DATAFORMAT_TYPE = DATAFORMAT_TYPE.MV
LinkarClt.ExecuteAsync_Text(New LinkarClt.OperationAsyncCallbackString(ExecuteAsyncFinished), crdOpt, statement, outputStringType)
No code example is currently available or this language may not be supported.
No code example is currently available or this language may not be supported.
See Also