Click or drag to resize

LinkarCltSelect Method (CredentialsOptions, String, String, String, String, String, SelectOptions, String, Int32)

Executes a Query in the Database, in a synchronous way.
Direct Method.

Namespace:  LinkarClient
Assemblies:   LinkarClientCore (in LinkarClientCore.dll) Version: 2.1.0.0
  LinkarClientMono (in LinkarClientMono.dll) Version: 2.1.0.0 (2.1.0.0)
  LinkarClient (in LinkarClient.dll) Version: 2.1.0.0 (2.1.0.0)
Syntax
public static LkData Select(
	CredentialsOptions credentialsOptions,
	string filename,
	string selectClause = "",
	string sortClause = "",
	string dictClause = "",
	string preSelectClause = "",
	SelectOptions selectOptions = null,
	string customVars = "",
	int receiveTimeout = 0
)

Parameters

credentialsOptions
Type: LinkarCommonCredentialsOptions
Object that defines the necessary data to access to the Linkar Server: Username, Password, EntryPoint, Language, FreeText.
filename
Type: SystemString
File name. For example LK.ORDERS
selectClause (Optional)
Type: SystemString
Fragment of the phrase that indicate the selection condition. For example WITH CUSTOMER = '1'
sortClause (Optional)
Type: SystemString
Fragment of the phrase that indicates the selection order. If there is a selection rule, Linkar will execute a SSELECT, otherwise Linkar will execute a SELECT. For example BY CUSTOMER
dictClause (Optional)
Type: SystemString
Is the list of dictionaries to read, separated by space. If dictionaries are not indicated the function will read the complete buffer. For example CUSTOMER DATE ITEM
preSelectClause (Optional)
Type: SystemString
It's an optional statement that will execute before the main Select
selectOptions (Optional)
Type: LinkarCommonSelectOptions
Object that defines the different reading options of the Function: calculated, dictionaries, conversion, formatSpec, originalRecords, onlyItemId, pagination, regPage, numPage.
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: LkData
Returns an object of type LkData with the results of the operation.
Exceptions
ExceptionCondition
SocketException

Thrown when there are communication problems between LINKAR Client and LINKAR Server

LkException

Thrown when there are errors in LINKAR Client or LINKAR Server

Examples
CredentialsOptions crdOpt = new CredentialsOptions("127.0.0.1", 11300, "admin", "admin", "ENTRYPOINT");

string filename = "LK.CUSTOMERS";
string selectClause = "";
string sortClause = "";
string dictClause = "BY CODE";
string preSelectClause = "";
SelectOptions selectOptions = new SelectOptions();
LkData lkDataSelect = LinkarClt.Select(crdOpt, filename, selectClause, sortClause, dictClause, preSelectClause, selectOptions);
See Also