LinkarCltLkProperties_Text Method (CredentialsOptions, String, LkPropertiesOptions, DATAFORMATSCH_TYPE, String, Int32)

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

Public Shared Function LkProperties_Text ( 
	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
) As String

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

static member LkProperties_Text : 
        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
*)
-> string

Parameters

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

Return Value

Type: String
Returns an object of type LkString 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");

string filename = "LK.CUSTOMERS";
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);
string result = LinkarClt.LkProperties_Text(crdOpt, filename, optProSchTypeLk, outputStringType);

// Get File Properties with Schema type SQL
LkPropertiesOptions optProSchTypeSql = new LkPropertiesOptions(onlyVisibles);
string result2 = LinkarClt.LkProperties_Text(crdOpt, filename, optProSchTypeSql, outputStringType);

// Get File Properties with Schema type DICTIONARIES
LkPropertiesOptions optProSchTypeDict = new LkPropertiesOptions(rowHeaders);
string result3 = LinkarClt.LkProperties_Text(crdOpt, filename, optProSchTypeDict, outputStringType);

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

Dim filename As String = "LK.CUSTOMERS"
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)
Dim result As String = LinkarClt.LkProperties_Text(crdOpt, filename, optProSchTypeLk, outputStringType)

' Get File Properties with Schema type SQL
Dim optProSchTypeSql As LkPropertiesOptions = New LkPropertiesOptions(onlyVisibles)
Dim result2 As String = LinkarClt.LkProperties_Text(crdOpt, filename, optProSchTypeSql, outputStringType)

' Get File Properties with Schema type DICTIONARIES
Dim optProSchTypeDict As LkPropertiesOptions = New LkPropertiesOptions(rowHeaders)
Dim result3 As String = LinkarClt.LkProperties_Text(crdOpt, filename, optProSchTypeDict, outputStringType)

Reference

LinkarClt Class

LkProperties_Text Overload

LinkarClient Namespace

LinkarCltAddLanguageSpecificTextSet("LST9971ED30_0?cpp=::|nu=.");LkProperties_Text Method (CredentialsOptions, String, LkPropertiesOptions, DATAFORMATSCH_TYPE, String, Int32)

Parameters

Return Value

Reference

LinkarCltLkProperties_Text Method (CredentialsOptions, String, LkPropertiesOptions, DATAFORMATSCH_TYPE, String, Int32)