beautypg.com

Call rtr_close_channel – Compaq AA-Q88CE-TE User Manual

Page 86

background image

CALL RTR_CLOSE_CHANNEL

CALL RTR_CLOSE_CHANNEL

The CALL RTR_CLOSE_CHANNEL command causes a command server to
execute the

rtr_close_channel( )

routine and to display the returned status.

Format

CALL RTR_CLOSE_CHANNEL

Command Qualifiers

Defaults

/CHANNEL_NAME=channel-name

/CHANNEL_NAME=RTR$DEFAULT_CHANNEL

/CLUSTER

/NOCLUSTER

/IMMEDIATE

/IMMEDIATE=RTR$DEFAULT_CHANNEL

/NODE[=node-list]

/NODE=default-node-list

/OUTPUT[=file-spec]

/OUTPUT=stdout

Description

The CALL RTR_CLOSE_CHANNEL command causes a command server to call

the

rtr_close_channel( )

routine using values supplied on the command line.

The numeric status returned from the call is then converted to its textual
representation and displayed.

The

rtr_close_channel( )

routine itself is described in Application

Programmer’s Reference Manual.

The prototype of

rtr_close_channel( )

is:

rtr_status_t

rtr_close_channel (

rtr_channel_t

channel,

rtr_clo_flag_t

flags

) ;

Table 6–4 shows the correspondence between values you supply on the command
line and the C language parameter values produced and used for the call.

Table 6–4 Parameters for rtr_close_channel

C Parameter Name

C Parameter Value

Command Line Specification

channel

/CHANNEL_NAME=name

flags

RTR_NO_FLAGS

[none] [D]

Qualifiers

/CHANNEL_NAME=channel_name
/CHANNEL_NAME=RTR$DEFAULT_CHANNEL

Specifies the channel for which the operation is to be performed.

The command server uses a combination of the channel_name and the window
from which the call was issued to uniquely identify which channel to use.

channel_name

is not case sensitive.

The default channel name is RTR$DEFAULT_CHANNEL.

You may close all the channels belonging to a window using
CLOSE CHANNEL/CHANNEL_NAME=*.

6–10 RTR Command Line Interface