BeginPeek(TimeSpan,Object) Method

Initiates an asynchronous peek operation that has a specified time-out and a specified state object, which provides associated information throughout the operation's lifetime. The operation is not complete until either a message becomes available in the queue or the time-out occurs.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Overloads Function BeginPeek( _
   ByVal timeout As TimeSpan, _
   ByVal stateObject As Object _
) As IAsyncResult

'Usage
 
Dim instance As MessageQueue
Dim timeout As TimeSpan
Dim stateObject As Object
Dim value As IAsyncResult
 
value = instance.BeginPeek(timeout, stateObject)

public IAsyncResult BeginPeek( 
   TimeSpan timeout,
   object stateObject
)

public:
IAsyncResult^ BeginPeek( 
   TimeSpan timeout,
   Object^ stateObject
)

Parameters

timeout: A System.TimeSpan that indicates the interval of time to wait for a message to become available.
stateObject: A state object, specified by the application, that contains information associated with the asynchronous operation.

Return Value

The System.IAsyncResult that identifies the posted asynchronous request.

Exceptions

Exception	Description
System.ArgumentException	The value specified for the timeout parameter is not valid.
MessageQueueException	An error occurred when accessing a Message Queuing method.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

MessageQueue Class
MessageQueue Members
Overload List