| LinkarClientLkProperties 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.PersistentAssembly: Linkar.Functions.Persistent (in Linkar.Functions.Persistent.dll) Version: 2.3.1
Syntax public string LkProperties(
string filename,
LkPropertiesOptions lkPropertiesOptions = null,
DATAFORMATSCHPROP_TYPE outputFormat = DATAFORMATSCHPROP_TYPE.MV,
string customVars = "",
int receiveTimeout = 0
)
Public Function LkProperties (
filename As String,
Optional lkPropertiesOptions As LkPropertiesOptions = Nothing,
Optional outputFormat As DATAFORMATSCHPROP_TYPE = DATAFORMATSCHPROP_TYPE.MV,
Optional customVars As String = "",
Optional receiveTimeout As Integer = 0
) As String
public:
String^ LkProperties(
String^ filename,
LkPropertiesOptions^ lkPropertiesOptions = nullptr,
DATAFORMATSCHPROP_TYPE outputFormat = DATAFORMATSCHPROP_TYPE::MV,
String^ customVars = L"",
int receiveTimeout = 0
)
member LkProperties :
filename : string *
?lkPropertiesOptions : LkPropertiesOptions *
?outputFormat : DATAFORMATSCHPROP_TYPE *
?customVars : string *
?receiveTimeout : int
(* Defaults:
let _lkPropertiesOptions = defaultArg lkPropertiesOptions null
let _outputFormat = defaultArg outputFormat DATAFORMATSCHPROP_TYPE.MV
let _customVars = defaultArg customVars ""
let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> string
Parameters
- 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
StringThe 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