Click or drag to resize

DirectFunctionsLkProperties Method

Linkar Framework for .NET and Core


Returns the Schema properties list defined in Linkar Schemas or the file dictionaries, synchronously only.

Namespace: Linkar.Functions.Direct
Assembly: Linkar.Functions.Direct (in Linkar.Functions.Direct.dll) Version: 2.3.1
Syntax
public static string LkProperties(
	CredentialOptions credentialOptions,
	string filename,
	LkPropertiesOptions lkPropertiesOptions = null,
	DATAFORMATSCHPROP_TYPE outputFormat = DATAFORMATSCHPROP_TYPE.MV,
	string customVars = "",
	int receiveTimeout = 0
)

Parameters

credentialOptions  CredentialOptions
Object with data necessary to access the Linkar Server: Username, Password, EntryPoint, Language, FreeText.
filename  String
File name to LkProperties.
lkPropertiesOptions  LkPropertiesOptions  (Optional)
This object defines the different options in base of the asked Schema Type: LKSCHEMAS, SQLMODE o DICTIONARIES.
outputFormat  DATAFORMATSCHPROP_TYPE  (Optional)
Indicates in what format you want to receive the data resulting from the operation: MV, XML, XML_DICT, XML_SCH, JSON, JSON_DICT, JSON_SCH or TABLE.
customVars  String  (Optional)
Free text sent to the database allows management of additional behaviours in SUB.LK.MAIN.CONTROL.CUSTOM, which is called when this parameter is set.
receiveTimeout  Int32  (Optional)
Maximum time in seconds that the client will wait for a response from the server. Default = 0 to wait indefinitely.

Return Value

String
The results of the operation.
Remarks
TABLE output format uses the defined control characters in EntryPoints Parameters Table Row Separator and Column Row Separator.

By default:

  • TAB char (9) for columns.
  • VT char (11) for rows.

See Also