Click or drag to resize

LinkarCltLkPropertiesAsync Method (LinkarCltOperationAsyncCallbackLkData, String, LkPropertiesOptions, String, Int32)

Returns the Schema properties list defined in Linkar Schemas or the file dictionaries, in a Asynchronous 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 void LkPropertiesAsync(
	OperationAsyncCallbackLkData cmdLkPropertiesFinished,
	string filename,
	LkPropertiesOptions lkPropertiesOptions = null,
	string customVars = "",
	int receiveTimeout = -1
)

Parameters

cmdLkPropertiesFinished
Type: LinkarClientOperationAsyncCallbackLkData
Return type in asynchronous methods
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).
Examples
LinkarClt lkClt = new LinkarClt();
CredentialsOptions crdOpt = new CredentialsOptions("127.0.0.1", 11300, "admin", "admin", "ENTRYPOINT");
lkClt.Login(crdOpt);

string filename = "LK.CUSTOMERS";
ROWHEADERS_TYPE rowHeaders = ROWHEADERS_TYPE.MAINLABEL;
bool rowProperties = true;
bool onlyVisibles = true;
bool usePropertyNames = true;

// Get File Properties with Schema type LKSCHEMAS
LkPropertiesOptions optProSchTypeLk = new LkPropertiesOptions(rowHeaders, rowProperties, onlyVisibles, usePropertyNames);
lkClt.LkPropertiesAsync(new LinkarClt.OperationAsyncCallbackLkData(LkPropertiesAsyncFinished), filename, optProSchTypeLk);

// Get File Properties with Schema type SQL
LkPropertiesOptions optProSchTypeSql = new LkPropertiesOptions(onlyVisibles);
lkClt.LkPropertiesAsync(new LinkarClt.OperationAsyncCallbackLkData(LkPropertiesAsyncFinished), filename, optProSchTypeSql);

// Get File Properties with Schema type DICTIONARIES
LkPropertiesOptions optProSchTypeDict = new LkPropertiesOptions(rowHeaders);
lkClt.LkPropertiesAsync(new LinkarClt.OperationAsyncCallbackLkData(LkPropertiesAsyncFinished), filename, optProSchTypeDict);
See Also