| LinkarCltExecute Method (String, String, Int32) |
Allows the execution of any command from the Database 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 LkData Execute(
string statement,
string customVars = "",
int receiveTimeout = -1
)
Public Function Execute (
statement As String,
Optional customVars As String = "",
Optional receiveTimeout As Integer = -1
) As LkData
public:
LkData^ Execute(
String^ statement,
String^ customVars = L"",
int receiveTimeout = -1
)
member Execute :
statement : string *
?customVars : string *
?receiveTimeout : int
(* Defaults:
let _customVars = defaultArg customVars ""
let _receiveTimeout = defaultArg receiveTimeout -1
*)
-> LkData
Parameters
- statement
- Type: SystemString
The command you want to execute in the Database. - 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:
LkDataReturns an object of type
LkData with the results of the operation.
Exceptions Exception | Condition |
---|
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 statement = "WHO";
LkData lkDataExecute = lkClt.Execute(statement);
Dim lkClt As LinkarClt = New LinkarClt
Dim crdOpt As CredentialsOptions = New CredentialsOptions("127.0.0.1", 11300, "admin", "admin", "ENTRYPOINT")
lkClt.Login(crdOpt)
Dim statement As String = "WHO"
Dim lkDataExecute As LkData = lkClt.Execute(statement)
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