System.Messaging Reference (Document! X Sample)
System.Messaging Namespace / MessageQueue Class / Receive Method / Receive(TimeSpan,Cursor) Method
A System.TimeSpan that indicates the time to wait until a new message is available for inspection.
A Cursor that maintains a specific position in the message queue.



In This Topic
    Receive(TimeSpan,Cursor) Method
    In This Topic
    Receives the current message in the queue, using a specified cursor. If no message is available, this method waits until either a message is available, or the time-out expires.
    Syntax
    'Declaration
     
    
    Public Overloads Function Receive( _
       ByVal timeout As TimeSpan, _
       ByVal cursor As Cursor _
    ) As Message
    'Usage
     
    
    Dim instance As MessageQueue
    Dim timeout As TimeSpan
    Dim cursor As Cursor
    Dim value As Message
     
    value = instance.Receive(timeout, cursor)
    public Message Receive( 
       TimeSpan timeout,
       Cursor cursor
    )
    public:
    Message^ Receive( 
       TimeSpan timeout,
       Cursor^ cursor
    ) 

    Parameters

    timeout
    A System.TimeSpan that indicates the time to wait until a new message is available for inspection.
    cursor
    A Cursor that maintains a specific position in the message queue.

    Return Value

    A Message that references the first message available in the queue.
    Exceptions
    ExceptionDescription
    The value specified for the timeout parameter is not valid, possibly timeout is less than System.TimeSpan.Zero or greater than InfiniteTimeout.
    A message did not arrive in the queue before the time-out expired.-or- An error occurred when accessing a Message Queuing method Use this overload to receive a message and return in a specified period of time if there are no messages in the queue.
    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

    See Also