QueueMarkerEvent method
Queues a marker event that fires after all other queued events.
Version added
5.0
Syntax
| |
|
intRet |
Long. The sequence number of the event that fires after all other queued events. |
|
object |
Required. An expression that returns an Application object. |
|
contextString |
Required String. An arbitrary string that is passed with the event that fires. |
Remarks
The QueueMarkerEvent method works in conjunction with the MarkerEvent event to allow an Automation client to queue an event to itself. The QueueMarkerEvent method causes the application to fire a MarkerEvent event after it has fired all of the events in its event queue.
The QueueMarkerEvent method returns the sequence number of the MarkerEvent event to fire, and the string passed to the QueueMarkerEvent method (legally empty) is passed to the MarkerEvent event handler.
A client program can use either the sequence number or the string to correlate QueueMarkerEvent calls with MarkerEvent events. In this way, the client is able to distinguish events it caused and events it did not cause.