| FunctionsDictionariesAsync Method |
Linkar Framework .NET (Core and Framework)
Returns all the dictionaries of a file, in a asynchronous way with XML output format.
Namespace: Linkar.Functions.Direct.XMLAssembly: Linkar.Functions.Direct.XML (in Linkar.Functions.Direct.XML.dll) Version: 2.3.1
Syntax public static Task<string> DictionariesAsync(
CredentialOptions credentialOptions,
string filename,
string customVars = "",
int receiveTimeout = 0
)
Public Shared Function DictionariesAsync (
credentialOptions As CredentialOptions,
filename As String,
Optional customVars As String = "",
Optional receiveTimeout As Integer = 0
) As Task(Of String)
public:
static Task<String^>^ DictionariesAsync(
CredentialOptions^ credentialOptions,
String^ filename,
String^ customVars = L"",
int receiveTimeout = 0
)
static member DictionariesAsync :
credentialOptions : CredentialOptions *
filename : string *
?customVars : string *
?receiveTimeout : int
(* Defaults:
let _customVars = defaultArg customVars ""
let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> Task<string>
Parameters
- credentialOptions CredentialOptions
- Object with data necessary to access the Linkar Server: Username, Password, EntryPoint, Language, FreeText.
- filename String
- File name
- 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.Direct.XML;
class Test
{
public string MyDictionaries()
{
string result = "";
try
{
CredentialOptions credentials = new CredentialOptions("127.0.0.1", "EPNAME", 11300, "admin", "admin");
result = Functions.DictionariesAsync(credentials, "LK.CUSTOMERS").Result;
}
catch (Exception ex)
{
string error = ex.Message;
}
return result;
}
}
Imports Linkar
Imports Linkar.Functions.Direct.XML
Class Test
Public Function MyDictionaries() As String
Dim result As String = ""
Try
Dim credentials As CredentialOptions = New CredentialOptions("127.0.0.1", "EPNAME", 11300, "admin", "admin")
result = Functions.DictionariesAsync(credentials, "LK.CUSTOMERS").Result
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