Click or drag to resize

LinkarCltLkPropertiesAsync_Text Method (LinkarCltOperationAsyncCallbackString, CredentialsOptions, String, LkPropertiesOptions, DATAFORMATSCH_TYPE, String, Int32)

Returns the Schema properties list defined in Linkar Schemas or the file dictionaries, in a Asynchronous 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
public static void LkPropertiesAsync_Text(
	OperationAsyncCallbackString cmdLkPropertiesFinished,
	CredentialsOptions credentialsOptions,
	string filename,
	LkPropertiesOptions lkPropertiesOptions = null,
	DATAFORMATSCH_TYPE outputStringType = DATAFORMATSCH_TYPE.MV,
	string customVars = "",
	int receiveTimeout = 0
)

Parameters

cmdLkPropertiesFinished
Type: LinkarClientOperationAsyncCallbackString
Return type in asynchronous methods
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.
outputStringType (Optional)
Type: LinkarCommonDATAFORMATSCH_TYPE
Indicates in what format you want to receive the data resulting from the operation: MV, XML, JSON or TABLE.
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
CredentialsOptions crdOpt = new CredentialsOptions("127.0.0.1", 11300, "admin", "admin", "ENTRYPOINT");

DATAFORMATSCH_TYPE outputStringType = DATAFORMATSCH_TYPE.MV;
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);
LinkarClt.LkPropertiesAsync_Text(new LinkarClt.OperationAsyncCallbackString(LkPropertiesAsyncFinished), crdOpt, optProSchTypeLk, outputStringType);

// Get File Properties with Schema type SQL
LkPropertiesOptions optProSchTypeSql = new LkPropertiesOptions(onlyVisibles);
LinkarClt.LkPropertiesAsync_Text(new LinkarClt.OperationAsyncCallbackString(LkPropertiesAsyncFinished), crdOpt, optProSchTypeSql, outputStringType);

// Get File Properties with Schema type DICTIONARIES
LkPropertiesOptions optProSchTypeDict = new LkPropertiesOptions(rowHeaders);
LinkarClt.LkPropertiesAsync_Text(new LinkarClt.OperationAsyncCallbackString(LkPropertiesAsyncFinished), crdOpt, optProSchTypeDict, outputStringType);
See Also