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

LISTPERGRPS Command

The LISTPERGRPS command lists the personal groups for a contact. A personal group is defined as a group of which the contact is a member. This command can also be used to list all the members of a specific group.

This command has the following format:

ADDRESS VOX "LISTPERGRPS NAME{({name|*}) | KEY(key)}
  [GRP(*|name|key)]
  [PREFIX(varname)]"

NAME

Specifies the name of the entity whose personal groups are to be listed.

An asterisk (*) returns a list of contacts that are members of the specified group.

Note: An asterisk (*) is valid only when the GRP operand is defined and the GRP operand is not defined as the wildcard character.

KEY

Specifies the key of the entity whose groups are to be listed.

GRP

(Optional) Specifies the group name or key to check for the membership of contacts.

An asterisk (*) returns a list of all groups of which the contact specified by NAME is a member.

Note: An asterisk (*) is valid only when the NAME operand is not defined as the wildcard character.

Default: *

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

Usage Note:

For more information on this command, see the sample REXX program listpergrps.rex in the CA Automation Point installation folder \sample\nm.

Return Information:

After the LISTPERGRPS 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.listpergrps.0 variable contains the number of lines of information returned. Each variable from VOX.listpergrps.1 to VOX.listpergrps.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.

Examples:

• The following command lists any group of which Chris Smith is a member:

  ADDRESS VOX "LISTPERGRPS NAME(Chris Smith)"
  

• The following command lists all the members of the Weekend Group:

  ADDRESS VOX "LISTPERGRPS NAME(*) GRP(Weekend Group)"