Syntax
| Visual Basic (Declaration) | |
|---|---|
Public Function BeginGetOutline( _ ByVal state As Object _ ) As IAsyncResult | |
| Visual Basic (Usage) |  Copy Code |
|---|---|
Dim instance As ImapMessage Dim state As Object Dim value As IAsyncResult value = instance.BeginGetOutline(state) | |
| C# | |
|---|---|
public IAsyncResult BeginGetOutline( object state ) | |
| Managed Extensions for C++ | |
|---|---|
public: IAsyncResult* BeginGetOutline( Object* state ) | |
| C++/CLI | |
|---|---|
public: IAsyncResult^ BeginGetOutline( Object^ state ) | |
Parameters
- state
- User state information.
Return Value
An IAsyncResult that represents the asynchronous operation, which could still be pending.Exceptions
| Exception | Description |
|---|---|
| System.InvalidOperationException | BeginXXX method used without providing an EndXXX event handler. |
| Dart.PowerTCP.Mail.ProtocolException | Bad IMAP protocol response received from server. |
| System.Net.Sockets.SocketException | The requested address is not valid in its context. |
Remarks
The ImapMessage.BeginGetOutline method gets the overall outline of the message (ImapMessageSections.BodyStructure), and fills in an outline Message object, with parts containing no data. Upon completion, the Imap.EndGetMessage event is raised. Different part objects are created based on the type and disposition of the definition returned by this command. In order to retrieve a single portion of this Message which has been created with empty parts, use the ImapMessage.GetPart or ImapMessage.BeginGetPart method, passing in as the part an object from the MessageStream.Parts collection.
Requirements
Target Platforms: Microsoft .NET Framework 2.0