LinkarCltLkSchemas Method (CredentialsOptions, LkSchemasOptions, String, Int32)

Returns a list of all the Schemas defined in Linkar Schemas, or the EntryPoint account data files, 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 LkSchemas(
	CredentialsOptions credentialsOptions,
	LkSchemasOptions lkSchemasOptions = null,
	string customVars = "",
	int receiveTimeout = 0
)

Public Shared Function LkSchemas ( 
	credentialsOptions As CredentialsOptions,
	Optional lkSchemasOptions As LkSchemasOptions = Nothing,
	Optional customVars As String = "",
	Optional receiveTimeout As Integer = 0
) As LkData

public:
static LkData^ LkSchemas(
	CredentialsOptions^ credentialsOptions, 
	LkSchemasOptions^ lkSchemasOptions = nullptr, 
	String^ customVars = L"", 
	int receiveTimeout = 0
)

static member LkSchemas : 
        credentialsOptions : CredentialsOptions * 
        ?lkSchemasOptions : LkSchemasOptions * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _lkSchemasOptions = defaultArg lkSchemasOptions 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.
lkSchemasOptions (Optional): Type: LinkarCommonLkSchemasOptions
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");

ROWHEADERS_TYPE rowHeaders = ROWHEADERS_TYPE.MAINLABEL;
bool rowProperties = true;
bool onlyVisibles = true;

// Get Schemas in LKSCHEMAS Mode
LkSchemasOptions optSchTypeLk = new LkSchemasOptions(rowHeaders, rowProperties, onlyVisibles);
LkData lkDataLkSchemas = LinkarClt.LkSchemas(crdOpt, optSchTypeLk);

// Get Schemas in SQL Mode
LkSchemasOptions optSchTypeSql = new LkSchemasOptions(onlyVisibles);
LkData lkDataLkSchemas2 = LinkarClt.LkSchemas(crdOpt, optSchTypeSql);

// Get Schemas in DICTIONARIES Mode
LkSchemasOptions optSchTypeDict = new LkSchemasOptions(rowHeaders);
LkData lkDataLkSchemas3 = LinkarClt.LkSchemas(crdOpt, optSchTypeDict);

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

Dim rowHeaders As ROWHEADERS_TYPE = ROWHEADERS_TYPE.MAINLABEL
Dim rowProperties As Boolean = True
Dim onlyVisibles As Boolean = True

' Get Schemas in LKSCHEMAS Mode
Dim optSchTypeLk As LkSchemasOptions = New LkSchemasOptions(rowHeaders, rowProperties, onlyVisibles)
Dim lkDataLkSchemas As LkData = LinkarClt.LkSchemas(crdOpt, optSchTypeLk)

' Get Schemas in SQL Mode
Dim optSchTypeSql As LkSchemasOptions = New LkSchemasOptions(onlyVisibles)
Dim lkDataLkSchemas2 As LkData = LinkarClt.LkSchemas(crdOpt, optSchTypeSql)

' Get Schemas in DICTIONARIES Mode
Dim optSchTypeDict As LkSchemasOptions = New LkSchemasOptions(rowHeaders)
Dim lkDataLkSchemas3 As LkData = LinkarClt.LkSchemas(crdOpt, optSchTypeDict)

Reference

LinkarClt Class

LkSchemas Overload

LinkarClient Namespace

LinkarCltAddLanguageSpecificTextSet("LSTA44D91A8_0?cpp=::|nu=.");LkSchemas Method (CredentialsOptions, LkSchemasOptions, String, Int32)

Parameters

Return Value

Reference

LinkarCltLkSchemas Method (CredentialsOptions, LkSchemasOptions, String, Int32)