Please enable JavaScript to view this site.

Navigation: Linkar CLIENTS > Client Functions

RunSubroutine, RunSubroutine_Text, RunSubroutineAsync, RunSubroutineAsync_Text

Scroll Prev Top Next More

Executes a subroutine, synchronously or asynchronously.

 

 

* hasError

(only C)

BOOL*

 

Only in C functions: bool pointer used in the C functions that indicates the return of the function is a system error and must be communicated to the Linkar SERVER

* callback

OperationAsyncCallbackString

OperationAsyncCallbackLkData

ArrayList

 

 

Return type in asynchronous methods. For further information see ASYNCHRONOUS CALLS

* credentialsOptions

CredentialsOptions

char*

 

 

Object that defines the necessary data to access the database: Username, Password, EntryPoint, Language, FreeText. In the C Direct Functions, it is a char*

* connectionInfo

(only C)

char*

 

Only in C Persistent Functions: string that is returned by the Login function and contains all the necessary connection data. This data is necessary in persistent functions.

* subroutineName

string

char*

 

 

Subroutine name to execute

* argsNumber

Numeric

 

 

Number of arguments that the subroutine accepts.

* arguments

string

char*

 

 

Subroutine arguments list separated by the LinkarCommon.ASCII_Chars.DC4 (20) character. The number of elements in the list must coincide with argsNumber.

outputStringType

enum DataFormat.TYPE

typedef uint8_t DataFormatTYPE;

 

DataFormat.TYPE.MV

Indicates in which format data is to be returned: MV, XML or JSON.

 

customVars

string

char*

 

This is a free text field to send in the transaction. If not empty, subroutine SUB.LK.MAIN.CONTROL.CUSTOM will be called. Add custom code to that subroutine to define special behaviours for some or all transactions.

receiveTimeout

Numeric

 

-1

0

 

This is the maximum time in seconds that the client will wait for a response. Use 0 for no timeout. This is a function-specific override : -1 in a Persistent function defaults back to the timeout defined in the LinkarClt constructor.

 

This function can generate exceptions.

In COM assemblies, a return value of type String will contain an error message if an error occurs when performing the operation.

 

Asynchronous calls are not yet available for C-based Client libraries including C, JavaScript, PHP, and Python.

 

       RunSubroutine. Persistent Functions

       RunSubroutine. Direct Functions

       RunSubroutineAsync. Persistent Functions

       RunSubroutineAsync. Direct Functions