PowerTCP Mail for .NET
Get(Stream,Int32) Method
See Also  Send comments on this topic.
Dart.PowerTCP.Mail Namespace > PopMessage Class > Get Method : Get(Stream,Int32) Method




message
The Stream to use for encapsulating the message.
lines
The amount of lines of the message to get.
Get a specified amount of lines of a single message from the server, specifying the Stream object to use for encapsulating the message.

Syntax

Visual Basic (Declaration) 
Public Overloads Function Get( _
   ByVal message As Stream, _
   ByVal lines As Integer _
) As PopMessage
Visual Basic (Usage)Copy Code
Dim instance As PopMessage
Dim message As Stream
Dim lines As Integer
Dim value As PopMessage
 
value = instance.Get(message, lines)
C# 
public PopMessage Get( 
   Stream message,
   int lines
)
Managed Extensions for C++ 
public: PopMessage* Get( 
   Stream* message,
   int lines
) 
C++/CLI 
public:
PopMessage^ Get( 
   Stream^ message,
   int lines
) 

Parameters

message
The Stream to use for encapsulating the message.
lines
The amount of lines of the message to get.

Return Value

A PopMessage object, representing the message retrieved.

Remarks

This method gets the amount of lines of a message specifies by lines, specifying the Stream to use. The behavior of this method depends on the type of Stream passed in. The following list describes how this method can be used:

  • If message is a FileStream, the encoded message will be dumped to disk.
  • If message is a MemoryStream, the encoded message will be in memory by accessing the PopMessage.Message property.
  • If message is a MessageStream, the decoded message will be in memory by accessing the PopMessage.Message property.

If you use this method to retrieve a partial message, PopMessage.Complete will be false because the entire message is not retrieved.

To perform this operation asynchronously, use the PopMessage.BeginGet method.

Requirements

Target Platforms: Microsoft .NET Framework 2.0

See Also

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