PeekById(String) Method

Peeks the message whose message identifier matches the parameter.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Overloads Function PeekById( _
   ByVal id As String _
) As Message

'Usage
 
Dim instance As MessageQueue
Dim id As String
Dim value As Message
 
value = instance.PeekById(id)

public Message PeekById( 
   string id
)

public:
Message^ PeekById( 
   String^ id
)

Parameters

id: The Id of the message to peek.

Return Value

The Message whose Id property matches the parameter.

Exceptions

Exception	Description
System.ArgumentNullException	The id parameter is null.
System.InvalidOperationException	No message with the specified id exists.
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