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

LISTFORTO Command

The LISTFORTO command lists all the time blocks that forward to a given entity (regardless of the time and date). The list is actually a tree and can contain any level of nesting.

This command has the following format:

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

NAME

Specifies the name of the entity for which the tree is to be created.

KEY

Specifies the key of the entity for which a tree is to be created.

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.LISTFORTO

Return Information:

After LISTFORTO 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.listforto.0 variable contains the number of lines of information returned. Each variable from VOX.listforto.1 to VOX.listforto.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, see the sample REXX program lstforto.rex, located in the CA Automation Point installation directory \sample\nm.

Example:

The following example checks the tree for Fran Smith at 10:00 a.m. on October 11:

ADDRESS VOX "LISTFORTO NAME(Fran Smith)"