Click or drag to resize

LinkarClientFormat Method

Linkar Framework for .NET and Core


Returns the result of executing the FMT function in a expressions list in the Database, synchronously only.

Namespace: Linkar.Functions.Persistent
Assembly: Linkar.Functions.Persistent (in Linkar.Functions.Persistent.dll) Version: 2.3.1
Syntax
public string Format(
	string expression,
	string formatSpec,
	DATAFORMAT_TYPE outputFormat = DATAFORMAT_TYPE.MV,
	string customVars = "",
	int receiveTimeout = 0
)

Parameters

expression  String
The data or expression to format. If multiple values are present, the operation will be performed individually on all values in the expression.
formatSpec  String
Specified format
outputFormat  DATAFORMAT_TYPE  (Optional)
Indicates in what format you want to receive the data resulting from the operation: MV, XML or JSON.
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.
See Also