| Visual Basic (Declaration) | |
|---|---|
Public Overloads Sub BeginGet( _ ByVal message As Stream, _ ByVal lines As Integer, _ ByVal state As Object _ ) | |
| Visual Basic (Usage) | Copy Code |
|---|---|
Dim instance As PopMessage Dim message As Stream Dim lines As Integer Dim state As Object instance.BeginGet(message, lines, state) | |
Parameters
- message
- The Stream to use for encapsulating the message.
- lines
- The amount of lines of the message to get.
- state
- User state information.
Return Value
An IAsyncResult that represents the asynchronous operation, which could still be pending.This method begins to get the amount of lines specifies by lines from a single message on the server, specifying the Stream to use. Upon completion, the Pop.EndGet event will be raised. A PopEventArgs object will be passed into the Pop.EndGet event, providing data about the message retrieved. 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 e.PopMessage.Message property.
- If message is a MessageStream, the decoded message will be in memory by accessing the e.PopMessage.Message property.
To perform this operation synchronously, use the PopMessage.Get method.
Target Platforms: Microsoft .NET Framework 2.0