Visara Master Console Center Scripting Guide - Manual (Page 215)

Chapter 6 Obsolete Material
Scripting Guide 215
EVENTCLOSE
Syntax:
EVENTCLOSE( %QueueID ) ==> %Status
Description:
Close an event queue.
Action:
Contacts the outside event daemon, and closes the specified queue.
Events are no longer available from the specified queue.
Parameters: %QueueID. Numeric expression. The ID of the queue to close. This
is the unique queue ID returned by EVENTOPEN().
Returns:
Numeric value, as follows:
Value
Meaning
0 Success
-1 Error
If %Status is error, the ERRORNUM function will return a value
according to the following table:
Error
11002
11003
11004
Manifest Constant
ERR_OED_QUEUE_NOT_OPEN
ERR_OED_REQUEST_FAILED
ERR_OED_RESPONSE_FAILED
Description
The queue is not open
The script could not
communicate with the
outside event daemon.
Make sure gwOed is
running.
The script did not
receive the correct
response from the
outside event
daemon. Make
sure gwOed is
running.
Notes:
Only use EVENTCLOSE() on queues opened with EVENTOPEN().
Example: // Open a queue for BMC Patrol events.
%queueId := EVENTOPEN( PATROL_EVENTS )
...
// Close the previously open queue.
%status := EVENTCLOSE( %queueId )
See Also: EVENTOPEN, EVENTREAD