Receives the first message available in the queue referenced by the MessageQueue. Waits the specified interval for a new message to be removed and uses the specified object to retrieve the result.
[Visual Basic] Overloads Public Function BeginReceive( _ ByVal timeout As TimeSpan, _ ByVal stateObject As Object _ ) As IAsyncResult [C#] public IAsyncResult BeginReceive( TimeSpan timeout, object stateObject ); [C++] public: IAsyncResult* BeginReceive( TimeSpan timeout, Object* stateObject ); [JScript] public function BeginReceive( timeout : TimeSpan, stateObject : Object ) : IAsyncResult;
The IAsyncResult that identifies the asynchronous request posted.
Exception Type | Condition |
---|---|
ArgumentException | The value specfied for the timeout parameter is invalid. It may represent a negative number. |
The state object is used to handle passing information across threads. In an asynchronous scenario, if a thread is started but the callback is on a different thread, the state object is marshaled and passed back along with information from the event.
BeginReceive is used in asynchronous processing to raise the System.Messaging.MessageQueue.MessageQueue.ReceiveCompleted event when a message is removed from the queue or the timeout has expired.
Because BeginReceive is asynchronous, you can use this method to peek the queue without blocking the current thread of execution. To peek the queue synchronously, use the Receive method.
MessageQueue Class | MessageQueue Members | System.Messaging Namespace | MessageQueue.BeginReceive Overload List | EndReceive | BeginPeek | Receive | Peek