Please enable JavaScript to view this site.

A-Shell Reference

Navigation: Subroutines > XTREE

XTREE Parameters

Scroll Prev Top Next More

Parameters that supply data to the routine are indicated with [in], and those used to get data back from the routine are labeled [out].

Parameter

Type

I/O

Description

Srow, Scol,
Erow, Ecol

String

in

Position of display.

Answer

 

in/out

Sets and returns the identity of the selected row(s), and/or in the case of editable cells, supplies and returns updated values.

Array

Array

in

In array mode, specifies an array of strings to be loaded into the list box.

Itemcount

Num

in

Specifies a number of items (i.e. "rows"), with the precise meaning being relative to the opcode:

Coldef

String

in

Defines the column structure.

Exitcode

+/-Num

out

Returns a code indicating how the list was exited; 0 indicates a normal exit via the Enter key, 1 indicates Escape. See the XTREE Flags parameter for enabling other exit keys.

XTREE Flags

B,4

in

Used to enable additional exit keys and other options.

File

String

in

Specifies a file to be used for input instead of the array parameter. This is referred to as "file mode."

Mmoclr

Struct

in

Specifies colors for various parts of the pick list.

XTRCTL

Struct

in/out

A collection of extended parameters and options.

Filidx

B,4

out

Creates an index to the file while it is being loaded into the array.

Xinfo

String

in/out

This optional parameter may be specified to allow XTREE to return additional information.