| LinkarClientLkSchemasAsync Method |
Linkar Framework for .NET and Core
Returns a list of all the Schemas defined in Linkar Schemas, or the EntryPoint account data files, in a asynchronous way with JSON output format.
Namespace: Linkar.Functions.Persistent.JSONAssembly: Linkar.Functions.Persistent.JSON (in Linkar.Functions.Persistent.JSON.dll) Version: 2.3.1
Syntax public Task<string> LkSchemasAsync(
LkSchemasOptions lkSchemasOptions = null,
string customVars = "",
int receiveTimeout = 0
)
Public Function LkSchemasAsync (
Optional lkSchemasOptions As LkSchemasOptions = Nothing,
Optional customVars As String = "",
Optional receiveTimeout As Integer = 0
) As Task(Of String)
public:
Task<String^>^ LkSchemasAsync(
LkSchemasOptions^ lkSchemasOptions = nullptr,
String^ customVars = L"",
int receiveTimeout = 0
)
member LkSchemasAsync :
?lkSchemasOptions : LkSchemasOptions *
?customVars : string *
?receiveTimeout : int
(* Defaults:
let _lkSchemasOptions = defaultArg lkSchemasOptions null
let _customVars = defaultArg customVars ""
let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> Task<string>
Parameters
- lkSchemasOptions LkSchemasOptions (Optional)
- This object defines the different options in base of the asked Schema Type: LKSCHEMAS, SQLMODE o DICTIONARIES.
- 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
TaskStringThe results of the operation.
Example using Linkar;
using Linkar.Functions.Persistent.JSON;
class Test
{
public string MyLkSchemas()
{
string result = "";
try
{
CredentialOptions credentials = new CredentialOptions("127.0.0.1", "EPNAME", 11300, "admin", "admin");
LinkarClient client = new LinkarClient();
client.Login(credentials);
LkSchemasOptions options = new LkSchemasOptions(RowHeaders.TYPE.MAINLABEL, false, false);
result = client.LkSchemasAsync(options).Result;
client.Logout();
}
catch (Exception ex)
{
string error = ex.Message;
}
return result;
}
}
Imports Linkar
Imports Linkar.Functions.Persistent.JSON
Class Test
Public Function MyLkSchemas() As String
Dim result As String = ""
Try
Dim credentials As CredentialOptions = New CredentialOptions("127.0.0.1", "EPNAME", 11300, "admin", "admin")
Dim client As LinkarClient = New LinkarClient()
client.Login(credentials)
Dim options As LkSchemasOptions = New LkSchemasOptions(RowHeaders.TYPE.MAINLABEL, False, False);
result = client.LkSchemasAsync(options).Result
client.Logout()
Catch ex As Exception
Dim[error] As String = ex.Message
End Try
Return result
End Function
End Class
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