ADDRESS VOX Commands › Voice Commands › STOP Command

STOP Command

The STOP command terminates a currently active I/O operation on a voice channel.

This command has the following format:

ADDRESS VOX "STOP CHANNELNUM(channelnumber)
  [SYSTEM(sysname)]"

CHANNELNUM

Specifies the channel number (channelnumber)-identifying some physical channel-that the GETCHANNELNUM command returns.

SYSTEM

(Optional) Specifies the name of the system that is running the notification server to which you want to direct the command. The sysname value can contain up to eight alphanumeric characters.

Default: The local system name.

Return Information:

After the STOP command executes, it sets the special REXX return code variable RC.

• If the command executes successfully, the RC variable contains a value of zero.
• If the command does not execute successfully, the RC variable contains one of the following values: 5117, 5199, 5201. (See the Message Reference Guide for more information.) Additionally the VOX.ERROR variable contains the complete VOX error message, which includes the four-digit return code and complete error message text.

Example:

The following REXX code illustrates how to use the STOP command to stop activity on all voice channels waiting for an incoming call:

signal on halt Shutdown
...

Shutdown:

/* Get a list of the local notification server's available channels. */

address vox 'getgroup group(all)'

parse var vox.getgroup.1 name interrupt numchannels channelsingroup

/* Check each channel to determine in-use status. */

do i = 1 to numchannels

    /* Get the next channel number in the group. */

    parse var channelsingroup channelnumber channelsingroup

    /* Determine the channel's in-use status. */

    address vox 'getstatus channelnum('channelnumber') prefix(status)'

   /* Stop all channels that are waiting for an incoming call. */

   if status <> "WTRNG" then
    do
      address vox 'stop channelnum('channelnumber')'
      ...

    end