PowerTCP Mail for .NET
EndGet Event
See Also  Send comments on this topic.
Dart.PowerTCP.Mail Namespace > Pop Class : EndGet Event




Raised when the PopMessage.BeginGet request completes.

Syntax

Visual Basic (Declaration) 
<CategoryAttribute("Completion")>
<DescriptionAttribute("Raised to report completion of BeginGet().")>
Public Event EndGet As PopEventHandler
Visual Basic (Usage)Copy Code
Dim instance As Pop
Dim handler As PopEventHandler
 
AddHandler instance.EndGet, handler
C# 
[CategoryAttribute("Completion")]
[DescriptionAttribute("Raised to report completion of BeginGet().")]
public event PopEventHandler EndGet
Managed Extensions for C++ 
[CategoryAttribute("Completion")]
[DescriptionAttribute("Raised to report completion of BeginGet().")]
public: __event PopEventHandler* EndGet
C++/CLI 
[CategoryAttribute("Completion")]
[DescriptionAttribute("Raised to report completion of BeginGet().")]
public:
event PopEventHandler^ EndGet

Event Data

The event handler receives an argument of type PopEventArgs containing data related to this event. The following PopEventArgs properties provide information specific to this event.

PropertyDescription
Exception Gets any exception which occurred during the asynchronous operation.
PopMessage Gets the PopMessage that was part of the associated method call.
State Gets the object that was included as part of the associated method call.

Remarks

This event is raised when the asynchronous method call PopMessage.BeginGet completes. A PopEventArgs object will be passed into the event, containing data about the retrieved message. For example, the PopMessage object itself is accessible by PopEventArgs.PopMessage. If an exception occurred during the asynchronous operation, it would also be returned in the PopEventArgs object in the PopEventArgs.Exception property. Be sure to check this property before accessing the PopMessage.

For more information on using events using PowerTCP.NET within the Visual Studio.NET environment, see Using Events Within The Visual Studio.NET Environment.

If you are using the Pop component as a reference, you must create a method to handle the event yourself. To learn how to do this, see Using Events When The A Component Is Used As A Reference.

This event MUST be implemented if you are using the Pop.BeginGet method. See Using EndXXX Events for more information.

Requirements

Target Platforms: Microsoft .NET Framework 2.0

See Also

Documentation Version 3.2
© 2010 Dart Communications. All Rights Reserved.