- EventTest
-
- retcode
- reascode
- monitor_token
- number_of_events
- event_flag
Purpose
Use the EventTest function to check the condition of an existing event monitor.
Parameters
- retcode
- (output,INT,4) is a variable where the function stores the return code.
- reascode
- (output,INT,4) is a variable where the function stores the reason code.
- monitor_token
- (input,INT,4) is a variable for specifying the token that identifies the monitor whose condition
is to be tested. A value of 0 may be used to identify the active event monitor most recently
activated on the current thread.
- number_of_events
- (input,INT,4) is a variable for specifying the number of events whose occurrence is to be
tested. In general, this should be the same as the number of event_name and event_key combinations
specified in the definition of the event monitor.
- event_flag
- (output,INT,number_of_events) is an array of
number_of_events 4-byte variables, in each element of which the function
returns an indication of the occurrence or nonoccurrence of the event identified by the
corresponding event list entries specified in defining the event monitor:
- 0,1,2,...
- The event has been signaled; the number is the length of data provided on the signal that may be
obtained with the EventRetrieve function.
- -1
- The event has not been signaled.
- -2
- The event definition has been deleted.
- -3
- No corresponding event list entry was defined in the event monitor.
Usage Notes
- A successful EventTest issued against an inactive event monitor causes the monitor to be
activated and establishes its current signal set.
- EventTest issued against an active event monitor simply reports on the current signal set.
- If monitor_token is specified as 0 and no monitor is active on the
current thread, an error return code is generated and no other action is taken.
Return Codes and Reason Codes
| Return Code |
Reason Code |
Meaning |
| vm_evn_success |
vm_evn_success |
EventTest completed successfully |
| vm_evn_warning |
vm_evn_event_truncated |
Number_of_events is less than the number of event list
entries specified in the creation of the event monitor; only a subset of event occurrences has been
indicated in event flags |
| vm_evn_warning |
vm_evn_cannot_satisfy |
Monitor cannot be satisfied |
| vm_evn_warning |
vm_evn_event_deleted |
One or more event names have been deleted |
| vm_evn_warning |
vm_evn_signal_lost |
One or more signals may have been lost due to lack of storage |
| vm_evn_warning |
vm_evn_monitor_inactive |
Condition is not satisfied |
| vm_evn_error |
vm_evn_no_monitor |
Monitor_token is unrecognizable |
| vm_evn_error |
vm_evn_no_active_monitor |
No monitor is active on the current thread |
| vm_evn_error |
vm_evn_bad_num_of_events |
Number_of_events is less than 0 |
Programming Language Bindings
| Language |
Language Binding File |
| C |
VMCEVN H |
| Assembler |
VMASMEVN MACRO |
| REXX |
VMREXEVN COPY |