Syntax
$RMEVENT |
CLASS={ USRCLS | class-name }
NAME=resource-name
MSG='message-text '
|
Use
Use the $RMEVENT API procedure to send a message to a defined resource. The resource definition must interpret the message and control the actual state of the resource. If necessary, relevant actions are invoked as part of this process. This procedure is typically used to control user-defined resources.
Operands
|
Operand |
Description |
|---|---|
|
CLASS={ USRCLS | class-name } |
The class of the resource that is the subject of the message. The default, USRCLS, specifies a user-defined resource class. |
|
NAME=resource-name |
The name of the resource that is the subject of the message. |
|
MSG='message-text' |
The text of the message that is sent to the resource. The message text must be enclosed in quotation marks. |
Returned Variable
|
Variable |
Description |
|---|---|
|
&SYSMSG |
Contains the message returned by $RMEVENT. |
Return Codes
The following return codes indicate the success or failure of processing:
|
&RETCODE |
Meaning |
|---|---|
|
0 |
Processing was successful. |
|
8 |
Processing failed. |
|
16 |
Error occurred in call syntax. |
Example
The following example sends a user-defined message (that is, a message defined in the USRCLS class) to the resource named MYRES01:
$RMEVENT NAME=MYRES01 MSG='RECOVER'