Click or drag to resize

LinkarCltGetTable_Text Method (String, String, String, String, TableOptions, String, Int32)

Returns a query result in a table format, in a Synchronous way.
Persistent 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 string GetTable_Text(
	string filename,
	string selectClause = "",
	string dictClause = "",
	string sortClause = "",
	TableOptions tableOptions = null,
	string customVars = "",
	int receiveTimeout = -1
)

Parameters

filename
Type: SystemString
File or table name defined in Linkar Schemas. Table notation is: MainTable[.MVTable[.SVTable]]
selectClause (Optional)
Type: SystemString
Fragment of the phrase that indicate the selection condition. For example WITH CUSTOMER = '1'
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
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
tableOptions (Optional)
Type: LinkarCommonTableOptions
Different function options: rowHeaders, rowProperties, onlyVisibe, usePropertyNames, repeatValues, applyConversion, applyFormat, calculated, 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: String
Returns an object of type LkString 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
LinkarClt lkClt = new LinkarClt();
CredentialsOptions crdOpt = new CredentialsOptions("127.0.0.1", 11300, "admin", "admin", "ENTRYPOINT");
lkClt.Login(crdOpt);

string filename = "LK.CUSTOMERS";
string selectClause = "";
string sortClause = "";
string dictClause = "";

ROWHEADERS_TYPE rowHeaders = ROWHEADERS_TYPE.MAINLABEL;
bool rowProperties = true;
bool onlyVisibles = true;
bool usePropertyNames = true;
bool repeatValues = true;
bool applyConversion =true;
bool applyFormat = true;
bool calculated = true;

// Get query with Schema type LKSCHEMAS
TableOptions tblOpSchTypeLk = new TableOptions(rowHeaders, rowProperties, onlyVisibles, usePropertyNames, repeatValues, applyConversion, applyFormat, calculated);
string result = lkClt.Table_Text(filename, selectClause, sortClause, dictClause, tblOpSchTypeLk);

// Get query with Schema type SQLMODE
TableOptions tblOpSchTypeSql = new TableOptions(onlyVisibles, applyConversion, applyFormat, calculated);
string result2 = lkClt.Table_Text(filename, selectClause, sortClause, dictClause, tblOpSchTypeSql);

// Get query with Schema type DICTIONARIES
TableOptions tblOpSchTypeDict = new TableOptions(rowHeaders, repeatValues, applyConversion, applyFormat, calculated);
string result3 = lkClt.Table_Text(filename, selectClause, sortClause, dictClause, tblOpSchTypeDict);

// Get query without any Schema type
TableOptions tblOpSchTypeNone = new TableOptions(rowHeaders, repeatValues);
string result4 = lkClt.Table_Text(filename, selectClause, sortClause, dictClause, tblOpSchTypeNone);
See Also