| LinkarCltConversion Method (CredentialsOptions, CONVERSION_TYPE, String, String, 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 public static LkData Conversion(
CredentialsOptions credentialsOptions,
CONVERSION_TYPE conversionType,
string expression,
string code,
string customVars = "",
int receiveTimeout = 0
)
Public Shared Function Conversion (
credentialsOptions As CredentialsOptions,
conversionType As CONVERSION_TYPE,
expression As String,
code As String,
Optional customVars As String = "",
Optional receiveTimeout As Integer = 0
) As LkData
public:
static LkData^ Conversion(
CredentialsOptions^ credentialsOptions,
CONVERSION_TYPE conversionType,
String^ expression,
String^ code,
String^ customVars = L"",
int receiveTimeout = 0
)
static member Conversion :
credentialsOptions : CredentialsOptions *
conversionType : CONVERSION_TYPE *
expression : string *
code : 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.
- 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. - 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:
LkDataReturns 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 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-";
LkData lkDataRead = LinkarClt.Read(crdOpt, conversionType, expression, code);
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 lkDataRead As LkData = LinkarClt.Read(crdOpt, conversionType, expression, code)
No code example is currently available or this language may not be supported.
No code example is currently available or this language may not be supported.
See Also