Language Reference Guide > Language Reference Guide > System Classes > GhostExec Class > PurgeUserEvent Method
Was this helpful?
PurgeUserEvent Method
The PurgeUserEvent method removes user events for a frame from the event queue.
This method has the following syntax:
integer = GhostExec.PurgeUserEvent([eventname =
          varchar(256)])
This method has the following parameter:
eventname
Specifies the user events that should be removed from the pending event queue for the frame and returns the number of events removed from the queue. If you do not specify the eventname parameter, OpenROAD removes all of the frame’s user events. You cannot use pattern matching in the eventname value.
You can use this method in conjunction with the resume statement to control the event queue. When a resume statement executes, OpenROAD removes all pending events except pending user events and database events from the queue. To remove user events also, use the PurgeUserEvent method to do so.
Note:  To remove database events from the queue, use the PurgeDBEvent Method.
Last modified date: 12/20/2023