ADDRESS VOX Commands › Notification Manager Database Maintenance Commands › LISTTIME Command

LISTTIME Command

The LISTTIME command lists all of the data for one or more time blocks. Specify one of the NAME or KEY operands. If the entity key or name is provided, all entries for the entity are listed. If the times table key is provided, just that entry is listed.

This command has the following format:

ADDRESS VOX "LISTTIME NAME(entity name)|KEY(entity|time key)
  [CMDRESP(destination)]  
  [PREFIX(varname)]"

NAME

Specifies the name of the entity whose time entries are to be listed. An asterisk (*) indicates that you want all times for all entities to be listed.

KEY

Specifies the key of the entity for whom all times are to be listed or the key of the time that is to be listed.

CMDRESP

(Optional) Directs return information, if any, to a specific destination. For a list of valid destination values, see the section ADDRESS VOX Return Information.

Default: REXX

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 the section ADDRESS VOX Return Information.

Default: VOX.LISTTIME

Return Information:

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

• If the command executes successfully, the RC variable contains a value of zero. The VOX.listtime.0 variable contains the number of lines of information returned. Each variable from VOX.listtime.1 to VOX.listtime.n contains a line of information. n represents the last line of return information.
• If the command does not execute successfully, the RC variable contains a nonzero value. The VOX.ERROR variable contains the complete VOX error message, which includes the four digit return code and error message text.

Usage Note:

For further details, refer to the sample REXX program listtime.rex, located in the CA Automation Point installation directory \sample\nm.