Please enable JavaScript to view this site.

Navigation: Linkar CLIENTS > Client Functions

LkSchemas, LkSchemas_Text, LkSchemasAsync, LkSchemasAsync_Text

Scroll Prev Top Next More

Returns a list of all Schemas defined in Linkar Schemas or from the MV account associated with the current EntryPoint, 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.

lkSchemasOptions

LkSchemasOptions

null /Nothing

NULL

This object defines the options to request a specific Schema Type:

: LKSCHEMAS, SQLMODE, or DICTIONARIES.

outputStringType

enum DataFormatSch.TYPE

typedef uint8_t DataFormatTYPE;

 

DataFormatSch.TYPE.MV

 

Indicates the format of the output data : MV, XML, JSON or TABLE

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.

 

 

TABLE output format uses the defined control characters in EntryPoints Parameters .Table Row Separator and Column Row Separator.

By default:

TAB char(9) for columns.

VT   char(11) for rows.

 

 

       LkSchema. Persistent Functions

       LkSchemas. Direct Functions

       LkSchemasAsync. Persistent Functions

       LkSchemasAsync. Direct Functions