LkPropertiesAsync_Text Method (LinkarClt.OperationAsyncCallbackString, CredentialsOptions, String, LkPropertiesOptions, DATAFORMATSCH_TYPE, String, Int32)

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

C++

Copy

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
)

Public Shared Sub LkPropertiesAsync_Text ( 
	cmdLkPropertiesFinished As OperationAsyncCallbackString,
	credentialsOptions As CredentialsOptions,
	filename As String,
	Optional lkPropertiesOptions As LkPropertiesOptions = Nothing,
	Optional outputStringType As DATAFORMATSCH_TYPE = DATAFORMATSCH_TYPE.MV,
	Optional customVars As String = "",
	Optional receiveTimeout As Integer = 0
)

public:
static void LkPropertiesAsync_Text(
	OperationAsyncCallbackString^ cmdLkPropertiesFinished, 
	CredentialsOptions^ credentialsOptions, 
	String^ filename, 
	LkPropertiesOptions^ lkPropertiesOptions = nullptr, 
	DATAFORMATSCH_TYPE outputStringType = DATAFORMATSCH_TYPE::MV, 
	String^ customVars = L"", 
	int receiveTimeout = 0
)

static member LkPropertiesAsync_Text : 
        cmdLkPropertiesFinished : OperationAsyncCallbackString * 
        credentialsOptions : CredentialsOptions * 
        filename : string * 
        ?lkPropertiesOptions : LkPropertiesOptions * 
        ?outputStringType : DATAFORMATSCH_TYPE * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _lkPropertiesOptions = defaultArg lkPropertiesOptions null
        let _outputStringType = defaultArg outputStringType DATAFORMATSCH_TYPE.MV
        let _customVars = defaultArg customVars ""
        let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> unit

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

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;
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);

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
Dim usePropertyNames As Boolean = True

' Get File Properties with Schema type LKSCHEMAS
Dim optProSchTypeLk As LkPropertiesOptions = New LkPropertiesOptions(rowHeaders, rowProperties, onlyVisibles, usePropertyNames)
LinkarClt.LkPropertiesAsync_Text(New LinkarClt.OperationAsyncCallbackString(LkPropertiesAsyncFinished), crdOpt, optProSchTypeLk, outputStringType)

' Get File Properties with Schema type SQL
Dim optProSchTypeSql As LkPropertiesOptions = New LkPropertiesOptions(onlyVisibles)
LinkarClt.LkPropertiesAsync_Text(New LinkarClt.OperationAsyncCallbackString(LkPropertiesAsyncFinished), crdOpt, optProSchTypeSql, outputStringType)

' Get File Properties with Schema type DICTIONARIES
Dim optProSchTypeDict As LkPropertiesOptions = New LkPropertiesOptions(rowHeaders)
LinkarClt.LkPropertiesAsync_Text(New LinkarClt.OperationAsyncCallbackString(LkPropertiesAsyncFinished), crdOpt, optProSchTypeDict, outputStringType)

Reference

LinkarClt Class

LkPropertiesAsync_Text Overload

LinkarClient Namespace

LinkarCltAddLanguageSpecificTextSet("LST148780C_0?cpp=::|nu=.");LkPropertiesAsync_Text Method (LinkarCltAddLanguageSpecificTextSet("LST148780C_1?cpp=::|nu=.");OperationAsyncCallbackString, CredentialsOptions, String, LkPropertiesOptions, DATAFORMATSCH_TYPE, String, Int32)

Parameters

Reference

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