LinkarCltFormat Method (CredentialsOptions, String, String, String, Int32)

Returns the result of executing the FMT function in a expressions list in the Database, in a Synchronous way.

Direct 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

C++

Copy

public static LkData Format(
	CredentialsOptions credentialsOptions,
	string expression,
	string formatSpec,
	string customVars = "",
	int receiveTimeout = 0
)

Public Shared Function Format ( 
	credentialsOptions As CredentialsOptions,
	expression As String,
	formatSpec As String,
	Optional customVars As String = "",
	Optional receiveTimeout As Integer = 0
) As LkData

public:
static LkData^ Format(
	CredentialsOptions^ credentialsOptions, 
	String^ expression, 
	String^ formatSpec, 
	String^ customVars = L"", 
	int receiveTimeout = 0
)

static member Format : 
        credentialsOptions : CredentialsOptions * 
        expression : string * 
        formatSpec : string * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _customVars = defaultArg customVars ""
        let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> LkData

Parameters

credentialsOptions: Type: LinkarCommonCredentialsOptions
Object that defines the necessary data to access to the Linkar Server: Username, Password, EntryPoint, Language, FreeText.
expression: Type: SystemString
The data or expression to format. It can contain MV marks, in which case the conversion in each value will be executed according to the original MV mark.
formatSpec: Type: SystemString
Specified format
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: LkData
Returns an object of type LkData with the results of the operation.

Exceptions

Exception	Condition
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

C++

Copy

CredentialsOptions crdOpt = new CredentialsOptions("127.0.0.1", 11300, "admin", "admin", "ENTRYPOINT");

string expression = "1";
string formatSpec = "R#10";
LkData lkDataRead = LinkarClt.Read(crdOpt, expression, formatSpec);

Dim crdOpt As CredentialsOptions = New CredentialsOptions("127.0.0.1", 11300, "admin", "admin", "ENTRYPOINT")

Dim expression As String = "1"
Dim formatSpec As String = "R#10"
Dim lkDataRead As LkData = LinkarClt.Read(crdOpt, expression, formatSpec)

Reference

LinkarClt Class

Format Overload

LinkarClient Namespace

LinkarCltAddLanguageSpecificTextSet("LSTCCBBF3D6_0?cpp=::|nu=.");Format Method (CredentialsOptions, String, String, String, Int32)

Parameters

Return Value

Reference

LinkarCltFormat Method (CredentialsOptions, String, String, String, Int32)