QueryCancelSuspend event

Microsoft Visio Developer Reference

QueryCancelSuspend event

       

Occurs before the operating system enters a suspended state. If any event handler returns True, the Microsoft Visio instance will deny the operating system's request.

Version added

2000 SR-1

Syntax

Private Function object_QueryCancelSuspend(ByVal app As IVapplication) As Boolean

object

The WithEvents object that receives the event.

return value

False to allow the operation; True to cancel the operation.

Remarks

You will typically respond False and allow the operating system to enter a suspended state. If you have open network files you can close them when you receive the BeforeSuspend event. If you have open network files that you cannot close you can return True and Visio will deny the operating system's request.

  • If any event handler returns True (cancel), the instance will fire SuspendCanceled and not enter a suspended state.
  • If all handlers return False (don't cancel), the instance will fire BeforeSuspend and then enter a suspended state.

If your solution runs outside of the Visio process you cannot be assured of receiving this event. For this reason, you should monitor window messages in your program.

While a Visio instance is firing a query or cancel event it will respond to inquiries from client code but will refuse to perform operations. Client code can show forms or message boxes while responding to a query or cancel event.

If you're using Microsoft Visual Basic or Visual Basic for Applications, the syntax in this topic describes a common, efficient way to handle events.

If you want to create your own Event objects, use the Add or AddAdvise method. To create an Event object that runs an add-on, use the Add method as it applies to the EventList collection. To create an Event object that receives notification, use the AddAdvise method. To find an event code for the event you want to create, see Event codes.