NET/MASTER RMS Management and Operations Guide

ZRMSAPIN ( GETACTIVE )
RMS Procedure Calls
115415 NonStop NET/MASTER RMS Management and Operations Guide C–5
ZRMSAPIN ( GETACTIVE )
The ZRMSAPIN ( GETACTIVE ) procedure call retrieves information about active
subjects. If you do not specify a subject or a manager, information about all active
subjects under all managers is retrieved.
CALL ZRMSAPIN ( GETACTIVE [,
subject
[,
manager
] ] )
SHARE &RMS., &SYSMSG
SUBJECT=
subject
specifies the name of a subject and, additionally, names beginning with
subject
.
You can specify a subject from 1 through 34 characters long.
MANAGER=
manager
specifies the name of the manager. You can specify a manager from 1 through 32
characters long.
If you specify a manager, only information about the active subjects (as
determined by the value of the subject) under the specified manager is retrieved.
Considerations
After the ZRMSAPIN ( GETACTIVE ) procedure call completes, the system
variable &SYS.RETCODE is set to one of the following values:
Return Code Description
0 The request was completed successfully.
4 No action—the subject was not found.
16 Any other internal error; more information available in &SYSMSG.
After the ZRMSAPIN ( GETACTIVE ) procedure call completes, the following
variables contain additional information:
Variable Contains
&RMS.ACTIVE.MANAGER.n Manager of active subject n.
&RMS.ACTIVE.MSGTIME.n Message time for active subject n.
&RMS.ACTIVE.NUM Number of active subject entries found.
&RMS.ACTIVE.QUEUED.n Number of actions queued to subject n.
&RMS.ACTIVE.RULEID.n Rule ID for active subject n.
&RMS.ACTIVE.RULESET.n Ruleset name for active subject n.
&RMS.ACTIVE.SUBJECT.n Active subject n.
n A number from 1 through &RMS.ACTIVE.NUM