| LinkarClientLkPropertiesAsync Method |
Linkar Framework for .NET and Core
Returns the Schema properties list defined in Linkar Schemas or the file dictionaries, in a asynchronous way with MV output format.
Namespace: Linkar.Functions.Persistent.MVAssembly: Linkar.Functions.Persistent.MV (in Linkar.Functions.Persistent.MV.dll) Version: 2.3.1
Syntax public Task<string> LkPropertiesAsync(
string filename,
LkPropertiesOptions lkPropertiesOptions = null,
string customVars = "",
int receiveTimeout = 0
)
Public Function LkPropertiesAsync (
filename As String,
Optional lkPropertiesOptions As LkPropertiesOptions = Nothing,
Optional customVars As String = "",
Optional receiveTimeout As Integer = 0
) As Task(Of String)
public:
Task<String^>^ LkPropertiesAsync(
String^ filename,
LkPropertiesOptions^ lkPropertiesOptions = nullptr,
String^ customVars = L"",
int receiveTimeout = 0
)
member LkPropertiesAsync :
filename : string *
?lkPropertiesOptions : LkPropertiesOptions *
?customVars : string *
?receiveTimeout : int
(* Defaults:
let _lkPropertiesOptions = defaultArg lkPropertiesOptions null
let _customVars = defaultArg customVars ""
let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> Task<string>
Parameters
- filename String
- File name to LkProperties
- lkPropertiesOptions LkPropertiesOptions (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.MV;
class Test
{
public string MyLkProperties()
{
string result = "";
try
{
CredentialOptions credentials = new CredentialOptions("127.0.0.1", "EPNAME", 11300, "admin", "admin");
LinkarClient client = new LinkarClient();
client.Login(credentials);
LkPropertiesOptions options = new LkPropertiesOptions(RowHeaders.TYPE.MAINLABEL, false, false, false);
result = client.LkPropertiesAsync("LK.CUSTOMERS", options).Result;
client.Logout();
}
catch (Exception ex)
{
string error = ex.Message;
}
return result;
}
}
Imports Linkar
Imports Linkar.Functions.Persistent.MV
Class Test
Public Function MyLkProperties() 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 LkPropertiesOptions = New LkPropertiesOptions(RowHeaders.TYPE.MAINLABEL, False, False, False);
result = client.LkPropertiesAsync("LK.CUSTOMERS",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