LinkarCltLkProperties Method (CredentialsOptions, String, LkPropertiesOptions, String, Int32)

Returns the Schema properties list defined in Linkar Schemas or the file dictionaries, 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 LkData LkProperties(
	CredentialsOptions credentialsOptions,
	string filename,
	LkPropertiesOptions lkPropertiesOptions = null,
	string customVars = "",
	int receiveTimeout = 0
)

Public Shared Function LkProperties ( 
	credentialsOptions As CredentialsOptions,
	filename As String,
	Optional lkPropertiesOptions As LkPropertiesOptions = Nothing,
	Optional customVars As String = "",
	Optional receiveTimeout As Integer = 0
) As LkData

public:
static LkData^ LkProperties(
	CredentialsOptions^ credentialsOptions, 
	String^ filename, 
	LkPropertiesOptions^ lkPropertiesOptions = nullptr, 
	String^ customVars = L"", 
	int receiveTimeout = 0
)

static member LkProperties : 
        credentialsOptions : CredentialsOptions * 
        filename : string * 
        ?lkPropertiesOptions : LkPropertiesOptions * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _lkPropertiesOptions = defaultArg lkPropertiesOptions null
        let _customVars = defaultArg customVars ""
        let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> LkData

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 to LkProperties
lkPropertiesOptions (Optional): Type: LinkarCommonLkPropertiesOptions
This object defines the different options in base of the asked Schema Type: LKSCHEMAS, SQLMODE o DICTIONARIES.
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

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";
ROWHEADERS_TYPE rowHeaders = ROWHEADERS_TYPE.MAINLABEL;
bool rowProperties = true;
bool onlyVisibles = true;
bool userPropertyNames = true;

// Get File Properties in LKSCHEMAS Mode
LkPropertiesOptions optProSchTypeLk = new LkPropertiesOptions(rowHeaders, rowProperties, onlyVisibles, usePropertyNames);
LkData lkDataLkProperties = LinkarClt.LkProperties(crdOpt, filename, recordId, dictClause, optProSchTypeLk);

// Get File Properties in SQL Mode
LkPropertiesOptions optProSchTypeSql = new LkPropertiesOptions(onlyVisibles);
LkData lkDataLkProperties2 = LinkarClt.LkProperties(crdOpt, filename, optProSchTypeSql);

// Get File Properties in DICTIONARIES Mode
LkPropertiesOptions optProSchTypeDict = new LkPropertiesOptions(rowHeaders);
LkData lkDataLkProperties3 = LinkarClt.LkProperties(crdOpt, filename, optProSchTypeDict);

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

Dim filename As String = "LK.CUSTOMERS"
Dim rowHeaders As ROWHEADERS_TYPE = ROWHEADERS_TYPE.MAINLABEL
Dim rowProperties As Boolean = True
Dim onlyVisibles As Boolean = True
Dim usePropertyNames As Boolean = True

' Get File Properties in LKSCHEMAS Mode
Dim optProSchTypeLk As LkPropertiesOptions = New LkPropertiesOptions(rowHeaders, rowProperties, onlyVisibles, usePropertyNames)
Dim lkDataLkProperties As LkData = LinkarClt.LkProperties(crdOpt, filename, optProSchTypeLk)

' Get File Properties in SQL Mode
Dim optProSchTypeSql As LkPropertiesOptions = New LkPropertiesOptions(onlyVisibles)
Dim lkDataLkProperties2 As LkData = LinkarClt.LkProperties(crdOpt, filename, optProSchTypeSql)

' Get File Properties in DICTIONARIES Mode
Dim optProSchTypeDict As LkPropertiesOptions = New LkPropertiesOptions(rowHeaders)
Dim lkDataLkProperties3 As LkData = LinkarClt.LkProperties(crdOpt, filename, optProSchTypeDict)

Reference

LinkarClt Class

LkProperties Overload

LinkarClient Namespace

LinkarCltAddLanguageSpecificTextSet("LSTB0F33F59_0?cpp=::|nu=.");LkProperties Method (CredentialsOptions, String, LkPropertiesOptions, String, Int32)

Parameters

Return Value

Reference

LinkarCltLkProperties Method (CredentialsOptions, String, LkPropertiesOptions, String, Int32)