Guardian Procedure Calls Reference Manual

USEREVENT_SET_ Procedure
Summary
Syntax for C Programmers
Syntax for TAL Programmers
Parameters
Returned Value
Considerations
Summary
The USEREVENT_SET_ procedure defines the set of user events upon which an application intends
to wait, using the common wait and I/O completion procedures.
USEREVENT_SET_ defines the set of user events without waiting or checking these events; the
process can subsequently use the AWAITIO/FILE_COMPLETE_ family of procedures to wait on
these events. In addition to calling USEREVENT_SET_, the application must also call the
USEREVENTFILE_REGISTER_ procedure before the file-oriented wait to establish a file number to
access the application-defined user event set.
NOTE: Applications do not have to call USEREVENT_REGISTER_ before calling USEREVENT_SET_;
the two procedures are independent operations and can be called in either sequence. However,
both procedures must be called before the eventual file-oriented wait.
USEREVENT_SET_ can be invoked multiple times to either replace the event mask or add to it. It
can also be invoked to reset the defined event mask of the process to 0.
To retrieve the current set of defined user events that were set by prior USEREVENT_SET_ calls, use
USEREVENT_GET_.
USEREVENT_SET_ has two parameters: waitMask and options. The waitMask parameter is
a bit mask of application-defined user events. The options parameter determines whether the
supplied waitMask is to be logically ORed to the process’ existing wait mask or replace it.
NOTE: The USEREVENT_SET_ procedure is supported on systems running H06.27 and later
H-series RVUs and J06.16 and later J-series RVUs.
Syntax for C Programmers
#include <cextdecs(USEREVENT_SET_)>
int16 USEREVENT_SET_ ( uint32 waitMask
,int16 options );
Syntax for TAL Programmers
error := USEREVENT_SET_ ( waitMask ! i
,options ); ! i
Parameters
waitMask
input
UINT(32)
specifies an event mask of application-defined user events to wait on. This mask is a bit mask
of events. The higher-order bit has the higher priority. The units bit is reserved and ignored.
USEREVENT_SET_ Procedure 1469