Structure: channel

Object Description:

External communications channel

Creation Command:

channel or open commands

Permitted Scope:

local, global or application

Array Capability:

Yes

Membership Potential:

compound, gstructure, structure, custom

Graphic Primitive Capability:

No

User Function Capability:

Yes, channel_function

 

Generic Elements

.access

-

string

Access rights

.alength

*

numeric

Array length

.class

*

string

Identifier class (channel)

.desc

-

string

Description

.elements

*

string[26]

Structure element names

.etypes

*

string[26]

Structure element types

.is_class

*

numeric func

Whether identifier is an instance of a particular class

.is_proc

*

numeric

Whether identifier is a procedure/function

.num_elements

*

numeric

Structure element count (26)

.owner

*

string

Owner user-id

.time

-

time

Modification time

.type

*

string

Identifier type (channel)

.variant

*

string

Identifier variant (identifier)

* = Read only element.

 

Structure Elements

.atable

*

atable

Atable to be used during channel callbacks

.binary

*

numeric

Whether or not channel is open for binary communication

.close

*

procedure

Close the channel

.command

*

numeric func

Execute a command (peer channels only)

.customize

*

procedure

Extend the channel structure

.delimiter

-

string

Delimiting character(s)

.done

-

callback

Statements to be executed on termination

.eof

*

numeric

Whether at end-of-file

.evaluate

*

string func

Evaluate an expression (peer channels only)

.exec

-

callback

Statements to be executed during polling

.flush

*

numeric func

Flush input/output

.format

-

string

Format for written output

.id

*

numeric

Channel number

.line

*

numeric

Current text file line number

.menu_mode

-

numeric

Execution mode during polling

.mode

*

string

Access mode

.name

*

string

File or process name

.poll

-

numeric

Whether polling is active

.process_id

*

numeric

External process-id

.query

*

procedure

Execute server commands en-bloc

.rewind

*

numeric func

Rewind input

.serverr

-

numeric

Server error status

.session

*

procedure

Execute a block of server commands

.signal

*

numeric func

Send a Unix signal

.style

*

string

Channel type

.timeout

-

numeric

Read time-out in seconds

* = Read only element.