Please enable JavaScript to view this site.

Returns the Schema properties list defined in Linkar Schemas.

 

 

* filename

string

 

 

File or table name defined in Linkar Schemas.

Table notation is: MainTable[.MVTable[.SVTable]]

lkPropertiesOptions

See below

 

 

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

: LKSCHEMAS, SQLMODE, or DICTIONARIES.

outputStringType

 

 

 

 

Indicates the format of the data returned : MV, XML, JSON,JSON_DICT, JSON_SCH, XML_DICT, XML_SCH or TABLE

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.

customVars

string


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.

 

lkPropertiesOptions. All LkProperties function options

 

 

rowHeaders

 

 

 

Include headings in first row MAINLABEL (main headings), SHORTLABEL (short label headings), and NONE (without headings)

rowProperties

boolean

 

 

First row contains property names.

onlyVisibles

 

boolean

 

Use only Visible Schemas and Properties

usePropertyNames

 

boolean

 

Use Properties and Table names.

pagination

 

boolean

false

indicates if pagination is being used or not

regPage

 

Numeric

10

in case of pagination indicates the number of records by page. This must be greater than 0

numPage

Numeric

1

in case of pagination indicates the number of records by page. This must be greater than 0

 

There are 3 constructors for each possible Schema Type:

 

LKSCHEMAS options:
RowHeaders.TYPE
RowProperties
OnlyVisibles
UsePropertyNames

 

SQLMODE options:
OnlyVisibles

 

RowHeaders option: Formed TYPE value is NONE and RowProperties option is true.

 

DICTIONARIES options:
RowHeaders.TYPE

 

RowProperties, OnlyVisibles and UsePropertyNames options are always false.