LinkarCltResetCommonBlocks_Text Method (CredentialsOptions, DATAFORMAT_TYPE, 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 string ResetCommonBlocks_Text(
	CredentialsOptions credentialsOptions,
	DATAFORMAT_TYPE outputStringType,
	int receiveTimeout = 0
)

Public Shared Function ResetCommonBlocks_Text ( 
	credentialsOptions As CredentialsOptions,
	outputStringType As DATAFORMAT_TYPE,
	Optional receiveTimeout As Integer = 0
) As String

public:
static String^ ResetCommonBlocks_Text(
	CredentialsOptions^ credentialsOptions, 
	DATAFORMAT_TYPE outputStringType, 
	int receiveTimeout = 0
)

static member ResetCommonBlocks_Text : 
        credentialsOptions : CredentialsOptions * 
        outputStringType : DATAFORMAT_TYPE * 
        ?receiveTimeout : int 
(* Defaults:
        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.
outputStringType: Type: LinkarCommonDATAFORMAT_TYPE
Indicates in what format you want to receive the data resulting from the operation: MV, XML or JSON.
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");

DATAFORMAT_TYPE outputStringType = DATAFORMAT_TYPE.MV;
string result = LinkarClt.ResetCommonBlocks_Text(crdOpt, outputStringType);

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

Dim outputStringType As DATAFORMAT_TYPE = DATAFORMAT_TYPE.MV

Dim result As String = LinkarClt.ResetCommonBlocks_Text(crdOpt, outputStringType)

Reference

LinkarClt Class

ResetCommonBlocks_Text Overload

LinkarClient Namespace

LinkarCltAddLanguageSpecificTextSet("LSTC2120C43_0?cpp=::|nu=.");ResetCommonBlocks_Text Method (CredentialsOptions, DATAFORMAT_TYPE, Int32)

Parameters

Return Value

Reference

LinkarCltResetCommonBlocks_Text Method (CredentialsOptions, DATAFORMAT_TYPE, Int32)