MessageQueue.PeekById 方法

public:
 System::Messaging::Message ^ PeekById(System::String ^ id);

public System.Messaging.Message PeekById(string id);

member this.PeekById : string -> System.Messaging.Message

Public Function PeekById (id As String) As Message

參數

傳回

Message其Id性質與參數相符id。

例外狀況

範例

下列程式代碼範例示範 如何使用 PeekById(String)。

// Connect to a queue on the local computer.
MessageQueue^ queue = gcnew MessageQueue(".\\exampleQueue");

// Create a new message.
Message^ msg = gcnew Message("Example Message Body");

// Send the message.
queue->Send(msg, "Example Message Label");

// Get the message's Id property value.
String^ id = msg->Id;

// Simulate doing other work so the message has time to arrive.
System::Threading::Thread::Sleep(TimeSpan::FromSeconds(10.0));

// Peek at the message.
msg = queue->PeekById(id);

queue->Close();

// Connect to a queue on the local computer.
MessageQueue queue = new MessageQueue(".\\exampleQueue");

// Create a new message.
Message msg = new Message("Example Message Body");

// Send the message.
queue.Send(msg, "Example Message Label");

// Get the message's Id property value.
string id = msg.Id;

// Simulate doing other work so the message has time to arrive.
System.Threading.Thread.Sleep(TimeSpan.FromSeconds(10.0));

// Peek at the message.
msg = queue.PeekById(id);

備註

使用 PeekById(String) 可在不從隊列中移除的情況下，讀取具有已知訊息識別碼的訊息。 訊息的識別碼在訊息排隊企業中是唯一的，因此隊列中最多只有一則符合該 id 參數的訊息。 若隊列目前不包含該訊息，此過載會拋出例外。

另外兩種方法可以讓你在隊列中窺訊息： Peek 和 PeekByCorrelationId(String)。 此 Peek 方法會回傳佇列中的第一個訊息; PeekByCorrelationId(String) 回傳因向佇列發送訊息而產生的確認、報告或應用程式產生的回應訊息。

下表顯示此方法是否可在多種工作群組模式中使用。

另請參閱

• Id
• Peek()
• BeginPeek()

public:
 System::Messaging::Message ^ PeekById(System::String ^ id, TimeSpan timeout);

public System.Messaging.Message PeekById(string id, TimeSpan timeout);

member this.PeekById : string * TimeSpan -> System.Messaging.Message

Public Function PeekById (id As String, timeout As TimeSpan) As Message

參數

傳回

Message其Id性質與參數相符id。

例外狀況

範例

下列程式代碼範例示範 如何使用 PeekById(String, TimeSpan)。

// Connect to a queue on the local computer.
MessageQueue^ queue = gcnew MessageQueue(".\\exampleQueue");

// Create a new message.
Message^ msg = gcnew Message("Example Message Body");

// Send the message.
queue->Send(msg, "Example Message Label");

// Get the message's Id property value.
String^ id = msg->Id;

// Peek at the message.
msg = queue->PeekById(id, TimeSpan::FromSeconds(10.0));

queue->Close();

// Connect to a queue on the local computer.
MessageQueue queue = new MessageQueue(".\\exampleQueue");

// Create a new message.
Message msg = new Message("Example Message Body");

// Send the message.
queue.Send(msg, "Example Message Label");

// Get the message's Id property value.
string id = msg.Id;

// Peek at the message.
msg = queue.PeekById(id, TimeSpan.FromSeconds(10.0));

備註

使用 PeekById(String) 可在不從隊列中移除的情況下，讀取具有已知訊息識別碼的訊息。 訊息的識別碼在訊息排隊企業中是唯一的，因此隊列中最多只有一則符合該 id 參數的訊息。 若隊列目前未包含該訊息，且在逾時發生前沒有新訊息抵達，則會拋出異常。

該 timeout 參數未指定此方法的總執行時間。 它指定等待新訊息到達隊列的時間。 每當有新訊息抵達時，此方法會檢查該訊息的參數Id是否符合。id 若未完成，則重新開始逾時，等待另一則新訊息抵達。 因此，如果在逾時期內持續有新訊息抵達，這個方法有可能無限期地持續運行，無論是直到逾時期結束且沒有新訊息到達，或直到收到符合 Id 參數的 id 訊息。

另外兩種方法可以讓你在隊列中窺訊息： Peek 和 PeekByCorrelationId(String)。 此 Peek 方法會回傳佇列中的第一個訊息; PeekByCorrelationId(String) 回傳因向佇列發送訊息而產生的確認、報告或應用程式產生的回應訊息。

下表顯示此方法是否可在多種工作群組模式中使用。

另請參閱

• InfiniteTimeout
• Id
• Peek()
• BeginPeek()