System.Messaging Reference (Document! X Sample)
Peek() Method



System.Messaging Namespace > MessageQueue Class > Peek Method : Peek() Method
Returns without removing (peeks) the first message in the queue referenced by this MessageQueue. The Peek method is synchronous, so it blocks the current thread until a message becomes available.
Syntax
'Declaration
 
Public Overloads Function Peek() As Message
'Usage
 
Dim instance As MessageQueue
Dim value As Message
 
value = instance.Peek()
public Message Peek()
public:
Message^ Peek(); 

Return Value

The Message that represents the first message in the queue.
Exceptions
ExceptionDescription
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

See Also

Reference

MessageQueue Class
MessageQueue Members
Overload List