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

Returns a query result in a table format, 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

C++

Copy

public static string GetTable_Text(
	CredentialsOptions credentialsOptions,
	string filename,
	string selectClause = "",
	string dictClause = "",
	string sortClause = "",
	TableOptions tableOptions = null,
	string customVars = "",
	int receiveTimeout = 0
)

Public Shared Function GetTable_Text ( 
	credentialsOptions As CredentialsOptions,
	filename As String,
	Optional selectClause As String = "",
	Optional dictClause As String = "",
	Optional sortClause As String = "",
	Optional tableOptions As TableOptions = Nothing,
	Optional customVars As String = "",
	Optional receiveTimeout As Integer = 0
) As String

public:
static String^ GetTable_Text(
	CredentialsOptions^ credentialsOptions, 
	String^ filename, 
	String^ selectClause = L"", 
	String^ dictClause = L"", 
	String^ sortClause = L"", 
	TableOptions^ tableOptions = nullptr, 
	String^ customVars = L"", 
	int receiveTimeout = 0
)

static member GetTable_Text : 
        credentialsOptions : CredentialsOptions * 
        filename : string * 
        ?selectClause : string * 
        ?dictClause : string * 
        ?sortClause : string * 
        ?tableOptions : TableOptions * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _selectClause = defaultArg selectClause ""
        let _dictClause = defaultArg dictClause ""
        let _sortClause = defaultArg sortClause ""
        let _tableOptions = defaultArg tableOptions null
        let _customVars = defaultArg customVars ""
        let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> string

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 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

Exception	Condition
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

C++

Copy

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

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 = LinkarClt.Table_Text(crdOpt, filename, selectClause, sortClause, dictClause, tblOpSchTypeLk);

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

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

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

Dim crdOpt As CredentialsOptions = New CredentialsOptions("127.0.0.1", 11300, "admin", "admin", "ENTRYPOINT")

Dim filename As String = "LK.CUSTOMERS"
Dim selectClause As String = ""
Dim sortClause As String = ""
Dim dictClause As String = ""

Dim rowHeaders As ROWHEADERS_TYPE = ROWHEADERS_TYPE.MAINLABEL
Dim rowProperties As Boolean = True
Dim onlyVisibles As Boolean = True
Dim usePropertyNames As Boolean = True
Dim repeatValues As Boolean = True
Dim applyConversion As Boolean = True
Dim applyFormat As Boolean = True
Dim calculated As Boolean = True

' Get query with Schema type LKSCHEMAS
Dim tblOpSchTypeLk As TableOptions = New TableOptions(rowHeaders, rowProperties, onlyVisibles, usePropertyNames, repeatValues, applyConversion, applyFormat, calculated)
Dim result As String = LinkarClt.Table_Text(crdOpt, filename, selectClause, sortClause, dictClause, tblOpSchTypeLk)

' Get query with Schema type SQLMODE
Dim tblOpSchTypeSql As TableOptions = New TableOptions(onlyVisibles, applyConversion, applyFormat, calculated)
Dim result2 As String = LinkarClt.Table_Text(crdOpt, filename, selectClause, sortClause, dictClause, tblOpSchTypeSql)

' Get query with Schema type DICTIONARIES
Dim tblOpSchTypeDict As TableOptions = New TableOptions(rowHeaders, repeatValues, applyConversion, applyFormat, calculated)
Dim result3 As String = LinkarClt.Table_Text(crdOpt, filename, selectClause, sortClause, dictClause, tblOpSchTypeDict)

' Get query without any Schema type
Dim tblOpSchTypeNone As TableOptions = New TableOptions(rowHeaders, repeatValues)
Dim result4 As String = LinkarClt.Table_Text(crdOpt, filename, selectClause, sortClause, dictClause, tblOpSchTypeNone)

Reference

LinkarClt Class

GetTable_Text Overload

LinkarClient Namespace

LinkarCltAddLanguageSpecificTextSet("LSTA25B200C_0?cpp=::|nu=.");GetTable_Text Method (CredentialsOptions, String, String, String, String, TableOptions, String, Int32)

Parameters

Return Value

Reference

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