Guardian Procedure Calls Reference Manual

Parameters
userEventFilenum
output
INT .EXT:ref:1
on successful return, contains the file number to be passed to one of the
AWAITIO/FILE_COMPLETE_ family of procedures to wait for user events. This value is only
valid if the error returned value is 0.
errorDetail
output
INT .EXT:ref:1
specifies the file-system error obtained while registering the file:
Unable to obtain file-system buffer space.31
Unable to obtain a file-system control block.34
Returned Value
INT(16)
Outcome of the call:
Success in establishing a file number to access an application-defined user event set.0
Unsuccessful in establishing the mapping. See errorDetail for the file-system error obtained.1
Address of the userEventFileneum or errorDetail parameter is out of bounds.22
Considerations
• USEREVENTFILE_REGISTER_ and USEREVENT_SET_ must be called if the application will wait
for user events using the AWAITIO[X|XL], FILE_AWAITIO64_, or FILE_COMPLETE[L]_
procedures. Applications using user events, but not the AWAITIO[X|XL], FILE_AWAITIO64_,
or FILE_COMPLETE[L]_ procedures, must use USEREVENT_WAIT_ instead.
• The application must call FILE_CLOSE_ for userEventFileNum when the application is no
longer waiting for user events. FILE_CLOSE_ clears the currently defined user event set, as if
calling USEREVENT_SET_(0,0); it does not affect the set of pending user events. To wait for
user events after a FILE_CLOSE_ call, the process must invoke USEREVENTFILE_REGISTER_
and USEREVENT_SET_ again
• For a general discussion about user events, see USEREVENT... Procedures (page 1464).
1474 Guardian Procedure Calls (T-V)