ADDRESS VOX Commands › Voice Commands › GETSYSNAMES Command

GETSYSNAMES Command

The GETSYSNAMES command retrieves the system name of the local workstation and the system names of all connected notification server workstations, if any.

This command has the following format:

ADDRESS VOX "GETSYSNAMES [PREFIX(varname)]
  [CMDRESP(destination)]"

PREFIX

(Optional) Specifies the name of the REXX stem variable (other than the default name) that contains the return information for the command.

For information about changing the default variable name, see ADDRESS VOX Return Information in this chapter.

Default: VOX.GETSYSNAMES

CMDRESP

(Optional) Directs return information to a specific destination (destination). For a list of valid destination values, see ADDRESS VOX Return Information in this chapter.

Default: REXX

Return Information:

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

• If the command executes successfully, the RC variable contains a value of zero. Additionally, the GETSYSNAMES command returns this information in each of the VOX.GETSYSNAMES variables (VOX.GETSYSNAMES.1 through VOX.GETSYSNAMES.n):

The value stored in the VOX.GETSYSNAMES.0 variable represents the total number of system names retrieved.

• If the command does not execute successfully, the RC variable contains the following value: 5117. (See the Message Reference Guide for further 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 GETSYSNAMES command to retrieve the system names of all connected notification servers, and then use that information to determine whether each notification server is running and whether the connection to each notification server is active:

/* Get the system names of all connected notification servers. */

address vox 'getsysnames prefix(engines)'

/* Verify that the connected notification server is running and */
/* that the connection to it is still active.          */
/* If you are running the client only, this will fail. */
/* Adjust the REXX accordingly.                        */

do i = 1 to vox.getsysnames.0

   /* Issue a VOX command to the connected notification server */

   address vox 'getgroup system('engines.i')'

   /* Display the result. */

   select
      when RC == 0 then say 'Communication with notification server:
' engines.i 'verified.'
      ...
   end

end