FunctionsSelect Method

Linkar Framework for .NET and Core

Executes a Query in the Database, synchronously only, with XML output format.

Namespace: Linkar.Functions.Direct.XML
Assembly: Linkar.Functions.Direct.XML (in Linkar.Functions.Direct.XML.dll) Version: 2.3.1

Syntax

C++

Copy

public static string Select(
	CredentialOptions credentialOptions,
	string filename,
	string selectClause = "",
	string sortClause = "",
	string dictClause = "",
	string preSelectClause = "",
	SelectOptions selectOptions = null,
	FunctionsXML_FORMAT xmlFormat = FunctionsXML_FORMAT.XML,
	string customVars = "",
	int receiveTimeout = 0
)

Public Shared Function Select ( 
	credentialOptions As CredentialOptions,
	filename As String,
	Optional selectClause As String = "",
	Optional sortClause As String = "",
	Optional dictClause As String = "",
	Optional preSelectClause As String = "",
	Optional selectOptions As SelectOptions = Nothing,
	Optional xmlFormat As FunctionsXML_FORMAT = FunctionsXML_FORMAT.XML,
	Optional customVars As String = "",
	Optional receiveTimeout As Integer = 0
) As String

public:
static String^ Select(
	CredentialOptions^ credentialOptions, 
	String^ filename, 
	String^ selectClause = L"", 
	String^ sortClause = L"", 
	String^ dictClause = L"", 
	String^ preSelectClause = L"", 
	SelectOptions^ selectOptions = nullptr, 
	FunctionsXML_FORMAT xmlFormat = FunctionsXML_FORMAT::XML, 
	String^ customVars = L"", 
	int receiveTimeout = 0
)

static member Select : 
        credentialOptions : CredentialOptions * 
        filename : string * 
        ?selectClause : string * 
        ?sortClause : string * 
        ?dictClause : string * 
        ?preSelectClause : string * 
        ?selectOptions : SelectOptions * 
        ?xmlFormat : FunctionsXML_FORMAT * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _selectClause = defaultArg selectClause ""
        let _sortClause = defaultArg sortClause ""
        let _dictClause = defaultArg dictClause ""
        let _preSelectClause = defaultArg preSelectClause ""
        let _selectOptions = defaultArg selectOptions null
        let _xmlFormat = defaultArg xmlFormat FunctionsXML_FORMAT.XML
        let _customVars = defaultArg customVars ""
        let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> string

Parameters

credentialOptions CredentialOptions: Object with data necessary to access the Linkar Server: Username, Password, EntryPoint, Language, FreeText.
filename String: Name of file on which the operation is performed. For example LK.ORDERS
selectClause String (Optional): Statement fragment specifies the selection condition. For example WITH CUSTOMER = '1'
sortClause String (Optional): Statement fragment specifies 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 String (Optional): Space-delimited list of dictionaries to read. If this list is not set, all fields are returned. For example CUSTOMER DATE ITEM. You may use the format LKFLDx where x is the attribute number.
preSelectClause String (Optional): An optional command that executes before the main Select
selectOptions SelectOptions (Optional): Object with options to manage how records are selected, including calculated, dictionaries, conversion, formatSpec, originalRecords, onlyItemId, pagination, regPage, numPage.
xmlFormat FunctionsXML_FORMAT (Optional): Different XML output formats.
customVars String (Optional): Free text sent to the database allows management of additional behaviours in SUB.LK.MAIN.CONTROL.CUSTOM, which is called when this parameter is set.
receiveTimeout Int32 (Optional): Maximum time in seconds that the client will wait for a response from the server. Default = 0 to wait indefinitely.

Return Value

String
The results of the operation.

Remarks

In the preSelectClause argument these operations can be carried out before executing the Select statement:

Previously call to a saved list with the GET.LIST command to use it in the Main Select input
Make a previous Select to use the result as the Main Select input, with the SELECT or SSELECT commands.In this case the entire sentence must be indicated in the PreselectClause. For example:SSELECT LK.ORDERS WITH CUSTOMER = '1'
Exploit a Main File index to use the result as a Main Select input, with the SELECTINDEX command. The syntax for all the databases is SELECTINDEX index.name.value. For example SELECTINDEX ITEM,"101691"

Example

C++

Copy

using Linkar;
using Linkar.Functions.Direct.XML;

class Test
    {

        public string MySelect()
        {
            string result = "";
            try
            {
                CredentialOptions credentials = new CredentialOptions("127.0.0.1", "EPNAME", 11300, "admin", "admin");

                result = Functions.Select(credentials, "LK.CUSTOMERS");
            }
            catch (Exception ex)
            {
                string error = ex.Message;
                // Do something
            }
            return result;
        }
    }

Imports Linkar
Imports Linkar.Functions.Direct.XML

Class Test

    Public Function MySelect() As String
        Dim result As String = ""

        Try
            Dim credentials As CredentialOptions = New CredentialOptions("127.0.0.1", "EPNAME", 11300, "admin", "admin")

            result = Functions.Select(credentials, "LK.CUSTOMERS")            
        Catch ex As Exception

            Dim[error] As String = ex.Message
            ' Do something
        End Try

        Return result
  End Function
End Class

Reference

Functions Class

Linkar.Functions.Direct.XML Namespace