Click or drag to resize

LinkarCltLkSchemasAsync_Text Method (LinkarCltOperationAsyncCallbackString, LkSchemasOptions, DATAFORMATSCH_TYPE, String, Int32)

Returns a list of all the Schemas defined in Linkar Schemas, or the EntryPoint account data files, 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 LkSchemasAsync_Text(
	OperationAsyncCallbackString cmdLkSchemasFinished,
	LkSchemasOptions lkSchemasOptions = null,
	DATAFORMATSCH_TYPE outputStringType = DATAFORMATSCH_TYPE.MV,
	string customVars = "",
	int receiveTimeout = -1
)

Parameters

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

DATAFORMATSCH_TYPE outputStringType = DATAFORMATSCH_TYPE.MV;
ROWHEADERS_TYPE rowHeaders = ROWHEADERS_TYPE.MAINLABEL;
bool rowProperties = true;
bool onlyVisibles = true;

// Get Schemas with Schema type LKSCHEMAS
LkSchemasOptions optSchTypeLk = new LkSchemasOptions(rowHeaders, rowProperties, onlyVisibles);
lkClt.LkSchemasAsync_Text(new LinkarClt.OperationAsyncCallbackString(LkSchemasAsyncFinished), optSchTypeLk, outputStringType);

// Get Schemas with Schema type SQL
LkSchemasOptions optSchTypeSql = new LkSchemasOptions(onlyVisibles);
lkClt.LkSchemasAsync_Text(new LinkarClt.OperationAsyncCallbackString(LkSchemasAsyncFinished), optSchTypeSql, outputStringType);

// Get Schemas with Schema type DICTIONARIES
LkSchemasOptions optSchTypeDict = new LkSchemasOptions(rowHeaders);
lkClt.LkSchemasAsync_Text(new LinkarClt.OperationAsyncCallbackString(LkSchemasAsyncFinished), optSchTypeDict, outputStringType);
See Also