Returns the result of executing the FMT function on an expression list in the database, synchronously or asynchronously.
* hasError
(only C)
|
BOOL*
|
|
Only in C functions: bool pointer used in the C functions that indicates the return of the function is a system error and must be communicated to the Linkar SERVER
|
* callback
|
OperationAsyncCallbackString
OperationAsyncCallbackLkData
ArrayList
|
|
Return type in asynchronous methods. For further information see ASYNCHRONOUS CALLS
|
* credentialsOptions
|
CredentialsOptions
char*
|
|
Object that defines the necessary data to access the database: Username, Password, EntryPoint, Language, FreeText. In the C Direct Functions, it is a char*
|
* connectionInfo
(only C)
|
char*
|
|
Only in C Persistent Functions: string that is returned by the Login function and contains all the necessary connection data. This data is necessary in persistent functions.
|
* formatSpec
|
string
char*
|
|
FMT expression subject to DBMS-specification
|
* expression
|
string
char*
|
|
The data or expression to format. It can contain MV marks, in which case the conversion in each value will be executed.
|
outputStringType
|
enum DataFormat.TYPE
typedef uint8_t DataFormatTYPE;
|
DataFormat.TYPE.MV
|
Indicates format of the data to be received : MV, XML or JSON.
|
customVars
|
string
char*
|
|
This is a free text field to send in the transaction. If not empty, subroutine SUB.LK.MAIN.CONTROL.CUSTOM will be called. Add custom code to that subroutine to define special behaviours for some or all transactions.
|
receiveTimeout
|
Numeric
|
-1
0
|
This is the maximum time in seconds that the client will wait for a response. Use 0 for no timeout. This is a function-specific override : -1 in a Persistent function defaults back to the timeout defined in the LinkarClt constructor.
|
This function can generate exceptions.
In COM assemblies, a return value of type String will contain an error message if an error occurs when performing the operation.
Format. Persistent Functions
|
string result = linkarclt.Format_Text(expression, formatSpec, outputStringType, customVars, receiveTimeout);
LkData lkdata = linkarclt.Format(expression, formatSpec, customVars, receiveTimeout);
|
|
|
Dim result As String = _linkarclt.Format_Text(expression, formatSpec, outputStringType, customVars, receiveTimeout)
Dim _lkdata As LkData = _linkarclt.Format(expression, formatSpec, customVars, receiveTimeout)
|
|
|
String result = linkarclt.Format(expression, formatSpec, outputStringType, customVars, receiveTimeout);
LkData lkdata = linkarclt.Format(expression, formatSpec, customVars, receiveTimeout);
|
|
|
char* result = LkFormat(connectionInfo, &hasError, expression, formatSpec, outputStringType, customVars, receiveTimeout);
|
|
Format. Direct Functions
|
string result = LinkarClt.Format_Text(credentialsOptions, formatSpec, expression, outputStringType, customVars, receiveTimeout);
LkData lkdata = LinkarClt.Format(credentialsOptions, formatSpec, expression, customVars, receiveTimeout);
|
|
|
Dim result As String = LinkarClt.Format_Text(_credentialsOptions, formatSpec, expression, outputStringType, customVars, receiveTimeout)
Dim _lkdata As LkData = LinkarClt.Format(_credentialsOptions, formatSpec, expression, customVars, receiveTimeout)
|
|
|
String result = LinkarClt.Format_Text(credentialsOptions, expression, formatSpec, outputStringType, customVars, receiveTimeout);
LkData lkdata = LinkarClt.Format(credentialsOptions, expression, formatSpec, customVars, receiveTimeout);
|
|
|
char* result = LkFormatD(credentialsOptions, &hasError, expression, formatSpec, outputStringType, customVars, receiveTimeout);
|
|
FormatAsync. Persistent Functions
|
linkarclt.FormatAsync_Text(callback, expression, formatSpec, outputStringType, customVars, receiveTimeout);
linkarclt.FormatAsync(callback, expression, formatSpec, customVars, receiveTimeout);
|
|
|
_linkarclt.FormatAsync_Text(callback, expression, formatSpec, outputStringType, customVars, receiveTimeout)
_linkarclt.FormatAsync(callback, expression, formatSpec, customVars, receiveTimeout)
|
|
|
linkarclt.FormatAsync_Text(expression, formatSpec, outputStringType, customVars, receiveTimeout);
linkarclt.FormatAsync(expression, formatSpec, customVars, receiveTimeout);
|
|
FormatAsync. Direct Functions
|
LinkarClt.FormatAsync_Text(callback, credentialsOptions, expression, formatSpec, outputStringType, customVars, receiveTimeout);
LinkarClt.FormatAsync(callback, credentialsOptions, expression, formatSpec, customVars, receiveTimeout);
|
|
|
LinkarClt.FormatAsync_Text(callback, _credentialsOptions, expression, formatSpec, outputStringType, customVars, receiveTimeout)
LinkarClt.FormatAsync(callback, _credentialsOptions, expression, formatSpec, customVars, receiveTimeout)
|
|
|
LinkarClt.FormatAsync_Text(callback, credentialsOptions, expression, formatSpec, outputStringType, customVars, receiveTimeout);
LinkarClt.FormatAsync(callback, credentialsOptions, expression, formatSpec, customVars, receiveTimeout);
|
|
