Visual Basic (Declaration) | |
---|---|
Public Delegate Sub HolePunchRemoveCommandEventHandler( _ ByVal sender As Object, _ ByVal e As HolePunchRemoveCommandEventArgs _ ) |
Visual Basic (Usage) | Copy Code |
---|---|
|
C# | |
---|---|
public delegate void HolePunchRemoveCommandEventHandler( object sender, HolePunchRemoveCommandEventArgs e ) |
Managed Extensions for C++ | |
---|---|
public: __gc __delegate void HolePunchRemoveCommandEventHandler( Object* sender, HolePunchRemoveCommandEventArgs* e ) |
C++/CLI | |
---|---|
public delegate void HolePunchRemoveCommandEventHandler( Object^ sender, HolePunchRemoveCommandEventArgs^ e ) |
Parameters
- sender
- The source of the event.
- e
- A HolePunchRemoveCommandEventArgs that contains the event data.
When you create a HolePunchRemoveCommandEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. Delegates are similar to the method pointers of C++ and have two main uses: performing callbacks, and defining events. Delegates are defined at run time. Callback methods allow asynchronous processing: the method being called starts a thread and returns, during which time the thread does most of the work and calls the callback only when needed. Events use a publish and subscribe type pattern. A class 'publishes' an event and any number of classes can 'subscribe' to that event. The runtime notifies subscribers when an event occurs. Delegates that are used in defining events must be defined as taking two arguments: a publisher object, and an event information object (derived from the .NET EventArgs class). The delegate method is called once for each occurring hole in the hole punch configuration, For example, if there are three holes, the delegate gets called three times. if the Status is set to RemoveStatus.Remove status to have a particular hole removed. set it to RemoveStatus.NoRemove to leave the hole unchanged. set RemoveStatus.Cancel to abort. If HolePunchRemoveCommandFlags.ImageUnchanged and HolePunchRemoveCommandFlags.SingleRegion are being used, then the Status value will affects only the internal single region that contains all the changes.
Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family