MessageQueue.Purge メソッド

定義

名前空間:

System.Messaging

アセンブリ:

System.Messaging.dll

キューに含まれるすべてのメッセージを削除します。

public:
 void Purge();

public void Purge ();

member this.Purge : unit -> unit

Public Sub Purge ()

例外

MessageQueueException

メッセージ キューのメソッドにアクセスしたときにエラーが発生しました。

例

次のコード例は、Purge の使用方法を示します。

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

// Delete all messages from the queue.
queue->Purge();

queue->Close();

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

// Delete all messages from the queue.
queue.Purge();

注釈

キューを消去すると、メッセージ キューによってキュー変更フラグが設定され、 プロパティに影響します LastModifyTime 。 キューから消去されたメッセージは失われます。配信不能キューまたはジャーナル キューには送信されません。

次の表は、このメソッドがさまざまなワークグループ モードで使用できるかどうかを示しています。

ワークグループ モード	利用可能
ローカル コンピューター	はい
ローカル コンピューターと直接形式の名前	はい
リモート コンピューター	いいえ
リモート コンピューターと直接形式の名前	はい

こちらもご覧ください

• Close()
• Refresh()