LinkarClientLoginAsync Method

Linkar Framework for .NET and Core

/// Starts the communication with a server allowing making use of the rest of functions until the Close method is executed or the connection with the server gets lost, in a asynchronous way.

Namespace: Linkar.Functions.Persistent.TABLE
Assembly: Linkar.Functions.Persistent.TABLE (in Linkar.Functions.Persistent.TABLE.dll) Version: 2.3.1

Syntax

C++

Copy

public Task LoginAsync(
	CredentialOptions credentialOptions,
	string customVars = "",
	int receiveTimeout = 0
)

Public Function LoginAsync ( 
	credentialOptions As CredentialOptions,
	Optional customVars As String = "",
	Optional receiveTimeout As Integer = 0
) As Task

public:
Task^ LoginAsync(
	CredentialOptions^ credentialOptions, 
	String^ customVars = L"", 
	int receiveTimeout = 0
)

member LoginAsync : 
        credentialOptions : CredentialOptions * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _customVars = defaultArg customVars ""
        let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> Task

Parameters

credentialOptions CredentialOptions: Object with data necessary to access the Linkar Server: Username, Password, EntryPoint, Language, FreeText.
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

Task

[Missing <returns> documentation for "M:Linkar.Functions.Persistent.TABLE.LinkarClient.LoginAsync(Linkar.CredentialOptions,System.String,System.Int32)"]

Remarks

Login is actually a "virtual" operation which creates a new Client Session ID. No DBMS login is performed unless Linkar SERVER determines new Database Sessions are required - these operations are not related.

Reference

LinkarClient Class

Linkar.Functions.Persistent.TABLE Namespace