Starts communication with a server, allowing it to use synchronous or asynchronous functions until the Logout method is executed or until the connection with the server is terminated.
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.
Please see Client Functions for information critical to the use of this function.
* hasError (only C) |
BOOL* |
|
Only in C functions: bool pointer used in the C functions that indicates the return of the function is a system error and must be communicated to the Linkar SERVER |
* callback |
OperationAsyncCallbackString OperationAsyncCallbackLkData OperationAsyncCallbackClass ArrayList
|
|
Return type in asynchronous methods. For further information see ASYNCHRONOUS CALLS |
* credentialsOptions
|
|
|
Object that defines the necessary data to access the database: Username, Password, EntryPoint, Language, FreeText. In the C Direct Functions, it is a char* |
customVars |
string char* |
|
This is a free text field to send in the transaction. If not empty, subroutine SUB.LK.MAIN.CONTROL.CUSTOM will be called. Add custom code to that subroutine to define special behaviours for some or all transactions.
|
receiveTimeout |
Numeric
|
-1 |
This is the maximum time in seconds that the client will wait for a response. Use 0 for no timeout. This is a function-specific override : -1 in a Persistent function defaults back to the timeout defined in the LinkarClt constructor. |
This function can generate exceptions.
In COM assemblies, a return value of type String will contain an error message if an error occurs when performing the operation.
