LinkarCltResetCommonBlocks Method (CredentialsOptions, Int32)

Resets the COMMON variables with the 100 most used files 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 ResetCommonBlocks(
	CredentialsOptions credentialsOptions,
	int receiveTimeout = 0
)

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

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

static member ResetCommonBlocks : 
        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 lkDataResetCommonBlocks = LinkarClt.ResetCommonBlocks(crdOpt);

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

Dim lkDataResetCommonBlocks As LkData = LinkarClt.ResetCommonBlocks(crdOpt)

Reference

LinkarClt Class

ResetCommonBlocks Overload

LinkarClient Namespace

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

Parameters

Return Value

Reference

LinkarCltResetCommonBlocks Method (CredentialsOptions, Int32)