Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

MessageQueue.EndReceive Method

Completes the specified asynchronous receive operation.

Namespace:  System.Messaging
Assembly:  System.Messaging (in System.Messaging.dll)

member EndReceive : 
        asyncResult:IAsyncResult -> Message

Parameters

asyncResult
Type: System.IAsyncResult

The IAsyncResult that identifies the asynchronous receive operation to finish and from which to retrieve an end result.

Return Value

Type: System.Messaging.Message
The Message associated with the completed asynchronous operation.

ExceptionCondition
ArgumentNullException

The asyncResult parameter is a null reference (Nothing in Visual Basic).

ArgumentException

The syntax of the asyncResult parameter is not valid.

MessageQueueException

An error occurred when accessing a Message Queuing method.

When the ReceiveCompleted event is raised, EndReceive(IAsyncResult) completes the operation that was initiated by the BeginReceive call. To do so, EndReceive(IAsyncResult) receives the message.

BeginReceive can specify a time-out, which causes the ReceiveCompleted event to be raised if the time-out occurs before a message appears in the queue. When a time-out occurs without a message arriving in the queue, a subsequent call to EndReceive(IAsyncResult) throws an exception.

EndReceive(IAsyncResult) is used to read (removing from the queue) the message that caused the ReceiveCompleted event to be raised.

If you want to continue to asynchronously receive messages, you can again call BeginReceive after calling EndReceive(IAsyncResult).

The following table shows whether this method is available in various Workgroup modes.

Workgroup mode

Available

Local computer

Yes

Local computer and direct format name

Yes

Remote computer

No

Remote computer and direct format name

Yes

The following code example chains asynchronous requests. It assumes there is a queue on the local computer called "myQueue". The Main function begins the asynchronous operation that is handled by the MyReceiveCompleted routine. MyReceiveCompleted processes the current message and begins a new asynchronous receive operation.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft