LinkarCltGetVersion Method (CredentialsOptions, Int32)

Allows getting the server version, 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 GetVersion(
	CredentialsOptions credentialsOptions,
	int receiveTimeout = 0
)

Public Shared Function GetVersion ( 
	credentialsOptions As CredentialsOptions,
	Optional receiveTimeout As Integer = 0
) As LkData

public:
static LkData^ GetVersion(
	CredentialsOptions^ credentialsOptions, 
	int receiveTimeout = 0
)

static member GetVersion : 
        credentialsOptions : CredentialsOptions * 
        ?receiveTimeout : int 
(* Defaults:
        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.
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");

LkData lkDataVersion = LinkarClt.Version(crdOpt);

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

Dim lkDataVersion As LkData = LinkarClt.Version(crdOpt)

Reference

LinkarClt Class

GetVersion Overload

LinkarClient Namespace

LinkarCltAddLanguageSpecificTextSet("LST208153E4_0?cpp=::|nu=.");GetVersion Method (CredentialsOptions, Int32)

Parameters

Return Value

Reference

LinkarCltGetVersion Method (CredentialsOptions, Int32)