Click or drag to resize

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

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

Parameters

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
ExceptionCondition
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
LinkarClt lkClt = new LinkarClt();
CredentialsOptions crdOpt = new CredentialsOptions("127.0.0.1", 11300, "admin", "admin", "ENTRYPOINT");
lkClt.Login(crdOpt);

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 = lkClt.LkProperties_Text(filename, optProSchTypeLk, outputStringType);

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

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