MessageQueue.GetAllMessages メソッド
キューにあるすべてのメッセージを返します。
Public Function GetAllMessages() As Message()
[C#]
public Message[] GetAllMessages();
[C++]
public: Message* GetAllMessages() [];
[JScript]
public function GetAllMessages() : Message[];
戻り値
キューにあるすべてのメッセージを表す型 Message の配列。配列の順序は、メッセージがメッセージ キューのキューに存在する順序と同じです。
例外
例外の種類 | 条件 |
---|---|
MessageQueueException | メッセージ キューの API にアクセスしたときにエラーが発生しました。 |
解説
GetAllMessages は、キューにあるメッセージの静的なスナップショットを返します。メッセージへの動的リンクではありません。そのため、この配列を使用してキューのメッセージは変更できません。キューとリアルタイムに動的な対話 (メッセージの削除など) をするには、キューにあるメッセージの動的リストを返す GetMessageEnumerator メソッドを呼び出します。
GetAllMessages は、メソッドが呼び出された時点でキューにあるメッセージのコピーを返すため、キューに到達した新しいメッセージまたはキューから削除されたメッセージは反映されません。
メモ GetAllMessages は、 MessageReadPropertyFilter プロパティでフィルタをかけられていないプロパティだけを取得します。
このメソッドが各種のワークグループ モードで使用できるかどうかを次の表に示します。
ワークグループ モード | 使用可否 |
---|---|
ローカル コンピュータ | はい |
ローカル コンピュータ + 直接書式名 | はい |
リモート コンピュータ | いいえ |
リモート コンピュータ + 直接書式名 | はい |
必要条件
プラットフォーム: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ
.NET Framework セキュリティ:
- 直前の呼び出し元の完全信頼。このメンバは、部分的に信頼されているコードから使用することはできません。詳細の参照先 : 部分信頼コードからのライブラリの使用
参照
MessageQueue クラス | MessageQueue メンバ | System.Messaging 名前空間 | Message | GetMessageEnumerator