ADDRESS VOX Commands › Utility Commands › GETTAPIDEVICELIST Command

GETTAPIDEVICELIST Command

The GETTAPIDEVICELIST command lists all the Telephony Application Programming Interface (TAPI) devices that are installed under Windows on the Notification Server.

This command has the following format:

ADDRESS VOX "GETTAPIDEVICELIST 
  [PREFIX(varname)]
  [CMDRESP(destination)]
  [SYSTEM(sysname)]"

PREFIX

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

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

Default: VOX.GETTAPIDEVICELIST

CMDRESP

(Optional) Directs return information, if any, to a specific destination. For a list of valid destination values, see the ANSWER command.

Default: REXX

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 GETTAPIDEVICELIST 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, information is returned to variables VOX.GETTAPIDEVICELIST.0, VOX.GETTAPIDEVICELIST.1, and so on.

  The information returned contains the device ID (in numeric form) and the modem description installed on that device ID. Each line of information is in the format n:desc where n is the device ID and desc is the modem description. The value stored in the VOX.GETTAPIDEVICELIST.0 variable represents the total number of TAPI devices.

• If the command does not execute successfully, the RC variable contains a non-zero value. Additionally, the VOX.ERROR variable contains the complete VOX error message, which includes the four-digit return code and complete error message text.

  For example:

  0:U.S. Robotics 56K FAX EXT
  1:Motorola V.3225
  

  Note: You can write a REXX program to retrieve and parse this returned information. For coding techniques on how to do this, see the sample REXX program fragment under the PAGE command description.

  The numeric value returned in the VOX.GETTAPIDEVICELIST.0 variable represents the number of lines of data retrieved. Each line of information is in the format described above, and one line is returned per modem installed on the notification server workstation.

Example:

The following example returns all the devices in a stem variable and issues a SAY statement:

/* Display available TAPI device on AP Notification server using GETTAPIDEVICELIST */
address VOX "GETTAPIDEVICELIST"
if rc = 0 then
do
  if datatype (VOX.GETTAPIDEVICELIST.0) = "NUM" then
  do 
   do i = 1 to VOX.GETTAPIDEVICELIST.0
     say VOX.GETTAPIDEVICELIST.i
    
   end
  end
end
else
do
   say vox.error
end

return