LinkarCltConversion_Text Method (CredentialsOptions, CONVERSION_TYPE, String, String, DATAFORMAT_TYPE, String, Int32)

Returns the result of executing ICONV() or OCONV() functions from a expression 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 string Conversion_Text(
	CredentialsOptions credentialsOptions,
	CONVERSION_TYPE conversionType,
	string expression,
	string code,
	DATAFORMAT_TYPE outputStringType = DATAFORMAT_TYPE.MV,
	string customVars = "",
	int receiveTimeout = 0
)

Public Shared Function Conversion_Text ( 
	credentialsOptions As CredentialsOptions,
	conversionType As CONVERSION_TYPE,
	expression As String,
	code As String,
	Optional outputStringType As DATAFORMAT_TYPE = DATAFORMAT_TYPE.MV,
	Optional customVars As String = "",
	Optional receiveTimeout As Integer = 0
) As String

public:
static String^ Conversion_Text(
	CredentialsOptions^ credentialsOptions, 
	CONVERSION_TYPE conversionType, 
	String^ expression, 
	String^ code, 
	DATAFORMAT_TYPE outputStringType = DATAFORMAT_TYPE::MV, 
	String^ customVars = L"", 
	int receiveTimeout = 0
)

static member Conversion_Text : 
        credentialsOptions : CredentialsOptions * 
        conversionType : CONVERSION_TYPE * 
        expression : string * 
        code : string * 
        ?outputStringType : DATAFORMAT_TYPE * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _outputStringType = defaultArg outputStringType DATAFORMAT_TYPE.MV
        let _customVars = defaultArg customVars ""
        let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> string

Parameters

credentialsOptions: Type: LinkarCommonCredentialsOptions
Object that defines the necessary data to access to the Linkar Server: Username, Password, EntryPoint, Language, FreeText.
conversionType: Type: LinkarCommonCONVERSION_TYPE
Indicates the conversion type, input or output: Input=ICONV(); OUTPUT=OCONV()
expression: Type: SystemString
The data or expression to convert. It can have MV marks, in which case the conversion will execute in each value obeying the original MV mark.
code: Type: SystemString
The conversion code. It will have to obey the Database conversions specifications.
outputStringType (Optional): Type: LinkarCommonDATAFORMAT_TYPE
Indicates in what format you want to receive the data resulting from the operation: MV, XML or JSON.
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: String
Returns an object of type LkString 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");

CONVERSION_TYPE conversionType = CONVERSION_TYPE.INPUT;
string expression = "12-31-2017";
string code = "D2-";
DATAFORMAT_TYPE outputStringType = DATAFORMAT_TYPE.MV;
string result = LinkarClt.Conversion_Text(crdOpt, conversionType, expression, code, outputStringType);

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

Dim conversionType As CONVERSION_TYPE = CONVERSION_TYPE.INPUT
Dim expression As String = "12-31-2017"
Dim code As String = "D2-"
Dim outputStringType As DATAFORMAT_TYPE = DATAFORMAT_TYPE.MV
Dim result As String = LinkarClt.Conversion_Text(crdOpt, conversionType, expression, code, outputStringType)

Reference

LinkarClt Class

Conversion_Text Overload

LinkarClient Namespace

LinkarCltAddLanguageSpecificTextSet("LST6C4D608B_0?cpp=::|nu=.");Conversion_Text Method (CredentialsOptions, CONVERSION_TYPE, String, String, DATAFORMAT_TYPE, String, Int32)

Parameters

Return Value

Reference

LinkarCltConversion_Text Method (CredentialsOptions, CONVERSION_TYPE, String, String, DATAFORMAT_TYPE, String, Int32)