Click or drag to resize

LinkarCltLogin Method

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 Synchronous way.

Namespace:  LinkarClient
Assembly:  LinkarClientCOM (in LinkarClientCOM.dll) Version: 2.1.0.0 (2.1.0.0)
Syntax
Copy
public string Login(
	CredentialsOptions credentialsOptions,
	string customVars = "",
	int receiveTimeout = -1
)

Parameters

credentialsOptions
Type: LinkarCommonCredentialsOptions
Object that defines the necessary data to access to the Linkar Server: Username, Password, EntryPoint, Language, FreeText.
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: String
Empty string if there is no error. Otherwise, text string with the error message.
Examples
Copy
LinkarClt lkClt = new LinkarClt();
CredentialsOptions crdOpt = new CredentialsOptions("127.0.0.1", 11300, "admin", "admin", "ENTRYPOINT");
lkClt.Login(crdOpt);

// TODO

lkClt.Logout();
See Also