IIOCancelInformation interface

Exposes methods for posting a cancel window message to the process thread from the Progress Dialog.

This interface enables the progress dialog to post a thread message through PostThreadMessage to the worker thread to cancel its operations. The worker thread must periodically check the message queue through GetMessage, PeekMessage or MsgWaitForMultipleObjectsEx.

The IIOCancelInformation::SetCancelInformation method tells the progress dialog which thread ID and what message to PostThreadMessage when the user clicks Cancel. A thread ID of "zero" disables the sending operation for the cancel message.

Members

The IIOCancelInformation interface inherits from the IUnknown interface. IIOCancelInformation also has these types of members:

Methods

The IIOCancelInformation interface has these methods.

MethodDescription
GetCancelInformation

Returns information that is posted when a user selects Cancel from the progress UI. The process thread uses this method to find out which message the progress dialog will send to the process thread when the user hits cancel. The process thread then listens for this message and does its own cleanup upon receipt.

SetCancelInformation

Sets information that is posted when a user selects Cancel from the progress UI. Allows the main object to tell the progress dialog thread about the process thread so that the progress dialog can send the process thread the message id when the user clicks Cancel.

 

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Shobjidl.h

DLL

Shell32.dll

 

 

Show: