LinkarCltLkSchemasAsync_Text Method (LinkarCltOperationAsyncCallbackString, CredentialsOptions, 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.

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 void LkSchemasAsync_Text(
	OperationAsyncCallbackString cmdLkSchemasFinished,
	CredentialsOptions credentialsOptions,
	LkSchemasOptions lkSchemasOptions = null,
	DATAFORMATSCH_TYPE outputStringType = DATAFORMATSCH_TYPE.MV,
	string customVars = "",
	int receiveTimeout = 0
)

Public Shared Sub LkSchemasAsync_Text ( 
	cmdLkSchemasFinished As OperationAsyncCallbackString,
	credentialsOptions As CredentialsOptions,
	Optional lkSchemasOptions As LkSchemasOptions = Nothing,
	Optional outputStringType As DATAFORMATSCH_TYPE = DATAFORMATSCH_TYPE.MV,
	Optional customVars As String = "",
	Optional receiveTimeout As Integer = 0
)

public:
static void LkSchemasAsync_Text(
	OperationAsyncCallbackString^ cmdLkSchemasFinished, 
	CredentialsOptions^ credentialsOptions, 
	LkSchemasOptions^ lkSchemasOptions = nullptr, 
	DATAFORMATSCH_TYPE outputStringType = DATAFORMATSCH_TYPE::MV, 
	String^ customVars = L"", 
	int receiveTimeout = 0
)

static member LkSchemasAsync_Text : 
        cmdLkSchemasFinished : OperationAsyncCallbackString * 
        credentialsOptions : CredentialsOptions * 
        ?lkSchemasOptions : LkSchemasOptions * 
        ?outputStringType : DATAFORMATSCH_TYPE * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _lkSchemasOptions = defaultArg lkSchemasOptions null
        let _outputStringType = defaultArg outputStringType DATAFORMATSCH_TYPE.MV
        let _customVars = defaultArg customVars ""
        let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> unit

Parameters

cmdLkSchemasFinished: 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.
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

C++

Copy

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;

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

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

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

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

Dim outputStringType As DATAFORMATSCH_TYPE = DATAFORMATSCH_TYPE.MV
Dim rowHeaders As ROWHEADERS_TYPE = ROWHEADERS_TYPE.MAINLABEL
Dim rowProperties As Boolean = True
Dim onlyVisibles As Boolean = True

' Get Schemas with Schema type LKSCHEMAS
Dim optSchTypeLk As LkSchemasOptions = New LkSchemasOptions(rowHeaders, rowProperties, onlyVisibles)
LinkarClt.LkSchemasAsync_Text(New LinkarClt.OperationAsyncCallbackString(LkSchemasAsyncFinished), crdOpt, optSchTypeLk, outputStringType)

' Get Schemas with Schema type SQL
Dim optSchTypeSql As LkSchemasOptions = New LkSchemasOptions(onlyVisibles)
LinkarClt.LkSchemasAsync_Text(New LinkarClt.OperationAsyncCallbackString(LkSchemasAsyncFinished), crdOpt, optSchTypeSql, outputStringType)

' Get Schemas with Schema type DICTIONARIES
Dim optSchTypeDict As LkSchemasOptions = New LkSchemasOptions(rowHeaders)
LinkarClt.LkSchemasAsync_Text(New LinkarClt.OperationAsyncCallbackString(LkSchemasAsyncFinished), crdOpt, optSchTypeDict, outputStringType)

Reference

LinkarClt Class

LkSchemasAsync_Text Overload

LinkarClient Namespace

LinkarCltAddLanguageSpecificTextSet("LST6D9F73D5_0?cpp=::|nu=.");LkSchemasAsync_Text Method (LinkarCltAddLanguageSpecificTextSet("LST6D9F73D5_1?cpp=::|nu=.");OperationAsyncCallbackString, CredentialsOptions, LkSchemasOptions, DATAFORMATSCH_TYPE, String, Int32)

Parameters

Reference

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