MessageQueue.Purge メソッド

.NET Framework クラス ライブラリ リファレンス

MessageQueue.Purge メソッド

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

名前空間: System.Messaging
アセンブリ: System.Messaging (system.messaging.dll 内)
構文

Visual Basic (宣言)

Public Sub Purge

Visual Basic (使用法)

Dim instance As MessageQueue

instance.Purge

C#

public void Purge ()

C++

public:
void Purge ()

J#

public void Purge ()

JScript

public function Purge ()

例外

例外の種類	条件
MessageQueueException	メッセージ キューのメソッドにアクセスしたときにエラーが発生しました。

解説

キューをパージすると、メッセージ キューはキュー変更フラグを設定します。これは、LastModifyTime プロパティに影響を与えます。キューからパージされたメッセージは失われます。配信不能キューや履歴キューには送信されません。

このメソッドが各種のワークグループ モードで使用できるかどうかを次の表に示します。

ワークグループ モード	使用可否
ローカル コンピュータ	○
ローカル コンピュータと直接書式名	○
リモート コンピュータ	×
リモート コンピュータと直接書式名	○

使用例

Purge を使用するコード例を次に示します。

C#

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

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

C++

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

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

queue->Close();

J#

// Connect to a queue on the local computer.
MessageQueue queue = new MessageQueue(".\\exampleQueue");
// Delete all messages from the queue.
queue.Purge();

.NET Framework のセキュリティ

• 直前の呼び出し元に対する完全な信頼。このメンバは、部分的に信頼されているコードから使用することはできません。詳細については、「」を参照してください。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0

参照

関連項目
MessageQueue クラス
MessageQueue メンバ
System.Messaging 名前空間
Close
Refresh