Message.Body プロパティ

メッセージの内容を取得または設定します。

Public Property Body As Object
[C#]
public object Body {get; set;}
[C++]
public: __property Object* get_Body();public: __property void set_Body(Object*);
[JScript]
public function get Body() : Object;public function set Body(Object);

プロパティ値

メッセージの内容を指定するオブジェクト。オブジェクトとして使用できるのは、文字列、日付、通貨、数値、バイト配列、または任意のマネージ オブジェクトです。

例外

例外の種類 条件
InvalidOperationException Formatter プロパティが null 参照 (Visual Basic では Nothing) です。

または

フィルタ処理されたメッセージ キューが、 Body プロパティを無視します。

解説

メッセージの Body プロパティには、通常ではメッセージに関連付けられているデータが格納されます。アプリケーション固有のデータは AppSpecific プロパティと Extension プロパティに入れて送信することもできますが、できる限りメッセージの Body にメッセージ データを入れてください。シリアル化または暗号化されるのは、 Body プロパティの内容だけです。

Body プロパティには、サイズが 4 MB 以下のオブジェクトを含むことができます。 Message 型以外のオブジェクトを MessageQueue.Send を使って MessageQueue に送信する場合、そのオブジェクトは、 Peek または Receive によって返される Message インスタンスの Body プロパティに格納されます。

メモ    MessageQueue.Send("hello.") の中の文字列引数は、汎用オブジェクトの一例です。

BodyType プロパティは、メッセージ本文に格納されている情報のタイプを示します。メッセージ キューは、 Body プロパティの内容のタイプを識別するのにこの情報を使います。

Message オブジェクトを送信する前に、 Body プロパティまたは BodyStream プロパティのいずれかを指定します。このうち Body プロパティには、テキスト文字列、構造体オブジェクト、クラス インスタンス、埋め込みオブジェクトなど、シリアル化できる任意のオブジェクトを使用できます。

メッセージの内容を BodyStream プロパティに直接書き込む以外は、メッセージを送信する前に Formatter プロパティを設定します。 MessageQueue インスタンスで Send メソッドが呼び出された場合は、 Formatter プロパティに格納されている書式指定子を使用して、メッセージの本文がシリアル化されます。 Formatter プロパティの値を指定せずにメッセージを送信した場合、書式指定子は既定値の XmlMessageFormatter に設定されます。

使用例

[Visual Basic, C#, C++] 優先度が異なる 2 つのメッセージをキューに送信し、順番に取得する例を次に示します。

 
Imports System
Imports System.Messaging


Namespace MyProject
    _
   
   '/ <summary>
   '/ Provides a container class for the example.
   '/ </summary>
   Public Class MyNewQueue
      
      
      '**************************************************
      ' Provides an entry point into the application.
      '         
      ' This example sends and receives a message from
      ' a queue.
      '**************************************************
      Public Shared Sub Main()
         ' Create a new instance of the class.
         Dim myNewQueue As New MyNewQueue()
         
         ' Send messages to a queue.
         myNewQueue.SendMessage(MessagePriority.Normal, "First Message Body.")
         myNewQueue.SendMessage(MessagePriority.Highest, "Second Message Body.")
         
         ' Receive messages from a queue.
         myNewQueue.ReceiveMessage()
         myNewQueue.ReceiveMessage()
         
         Return
      End Sub 'Main
      
      
      
      '**************************************************
      ' Sends a string message to a queue.
      '**************************************************
      Public Sub SendMessage(priority As MessagePriority, messageBody As String)
         
         ' Connect to a queue on the local computer.
         Dim myQueue As New MessageQueue(".\myQueue")
         
         ' Create a new message.
         Dim myMessage As New Message()
         
         If priority > MessagePriority.Normal Then
            myMessage.Body = "High Priority: " + messageBody
         Else
            myMessage.Body = messageBody
         End If 
         ' Set the priority of the message.
         myMessage.Priority = priority
         
         
         ' Send the Order to the queue.
         myQueue.Send(myMessage)
         
         Return
      End Sub 'SendMessage
      
      
      
      '**************************************************
      ' Receives a message.
      '**************************************************
      Public Sub ReceiveMessage()
         ' Connect to the a queue on the local computer.
         Dim myQueue As New MessageQueue(".\myQueue")
         
         ' Set the queue to read the priority. By default, it
         ' is not read.
         myQueue.MessageReadPropertyFilter.Priority = True
         
         ' Set the formatter to indicate body contains a string.
         myQueue.Formatter = New XmlMessageFormatter(New Type() {GetType(String)})
         
         Try
            ' Receive and format the message. 
            Dim myMessage As Message = myQueue.Receive()
            
            ' Display message information.
            Console.WriteLine(("Priority: " + myMessage.Priority.ToString()))
            Console.WriteLine(("Body: " + myMessage.Body.ToString()))
         
         Catch
         ' Handle Message Queuing exceptions.
         
         ' Handle invalid serialization format.
         Catch e As InvalidOperationException
            Console.WriteLine(e.Message)
         End Try
         
         ' Catch other exceptions as necessary.
         Return
      End Sub 'ReceiveMessage
   End Class 'MyNewQueue
End Namespace 'MyProject

[C#] 
using System;
using System.Messaging;

namespace MyProject
{

    /// <summary>
    /// Provides a container class for the example.
    /// </summary>
    public class MyNewQueue
    {

        //**************************************************
        // Provides an entry point into the application.
        //         
        // This example sends and receives a message from
        // a queue.
        //**************************************************

        public static void Main()
        {
            // Create a new instance of the class.
            MyNewQueue myNewQueue = new MyNewQueue();

            // Send messages to a queue.
            myNewQueue.SendMessage(MessagePriority.Normal, "First Message Body.");
            myNewQueue.SendMessage(MessagePriority.Highest, "Second Message Body.");

            // Receive messages from a queue.
            myNewQueue.ReceiveMessage(); 
            myNewQueue.ReceiveMessage();

            return;
        }


        //**************************************************
        // Sends a string message to a queue.
        //**************************************************
        
        public void SendMessage(MessagePriority priority, string messageBody)
        {

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

            // Create a new message.
            Message myMessage = new Message();

            if(priority > MessagePriority.Normal)
            {
                myMessage.Body = "High Priority: " + messageBody;
            }
            else myMessage.Body = messageBody;

            // Set the priority of the message.
            myMessage.Priority = priority;


            // Send the Order to the queue.
            myQueue.Send(myMessage);

            return;
        }


        //**************************************************
        // Receives a message.
        //**************************************************
        
        public  void ReceiveMessage()
        {
            // Connect to the a queue on the local computer.
            MessageQueue myQueue = new MessageQueue(".\\myQueue");

            // Set the queue to read the priority. By default, it
            // is not read.
            myQueue.MessageReadPropertyFilter.Priority = true;

            // Set the formatter to indicate body contains a string.
            myQueue.Formatter = new XmlMessageFormatter(new Type[]
                {typeof(string)});
            
            try
            {
                // Receive and format the message. 
                Message myMessage =    myQueue.Receive(); 

                // Display message information.
                Console.WriteLine("Priority: " + 
                    myMessage.Priority.ToString());
                Console.WriteLine("Body: " + 
                    myMessage.Body.ToString());
            }
            
            catch (MessageQueueException)
            {
                // Handle Message Queuing exceptions.
            }

            // Handle invalid serialization format.
            catch (InvalidOperationException e)
            {
                Console.WriteLine(e.Message);
            }
            
            // Catch other exceptions as necessary.

            return;
        }
    }
}

[C++] 
#using <mscorlib.dll>
#using <system.dll>
#using <system.messaging.dll>

using namespace System;
using namespace System::Messaging;

__gc class MyNewQueue 
{
public:
    void SendMessage(MessagePriority priority, String* messageBody) 
    {

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

        // Create a new message.
        Message* myMessage = new Message();

        if (priority > MessagePriority::Normal) 
        {
            myMessage->Body = S"High Priority: {0}", messageBody;
        } 
        else myMessage->Body = messageBody;

        // Set the priority of the message.
        myMessage->Priority = priority;

        // Send the Order to the queue.
        myQueue->Send(myMessage);

        return;
    }

public:
    void ReceiveMessage() 
    {
        // Connect to the a queue on the local computer.
        MessageQueue* myQueue = new MessageQueue(S".\\myQueue");

        // Set the queue to read the priority. By default, it
        // is not read.
        myQueue->MessageReadPropertyFilter->Priority = true;

        // Set the formatter to indicate body contains a String*.
        Type* p __gc[] = new Type* __gc[1];
        p[0] = __typeof(String);
        myQueue->Formatter = new XmlMessageFormatter( p );

        try 
        {
            // Receive and format the message. 
            Message* myMessage = myQueue->Receive(); 

            // Display message information.
            Console::WriteLine(S"Priority: {0}", __box(myMessage->Priority));
            Console::WriteLine(S"Body: {0}", myMessage->Body);
        }
        catch (MessageQueueException*) 
        {
            // Handle Message Queuing exceptions.
        }

        // Handle invalid serialization format.
        catch (InvalidOperationException* e) 
        {
            Console::WriteLine(e->Message);
        }
        // Catch other exceptions as necessary.

        return;
    }
};

int main() 
{
    // Create a new instance of the class.
    MyNewQueue* myNewQueue = new MyNewQueue();

    // Send messages to a queue.
    myNewQueue->SendMessage(MessagePriority::Normal, S"First Message Body.");
    myNewQueue->SendMessage(MessagePriority::Highest, S"Second Message Body.");

    // Receive messages from a queue.
    myNewQueue->ReceiveMessage(); 
    myNewQueue->ReceiveMessage();

    return 0;

[JScript] JScript のサンプルはありません。Visual Basic、C#、および C++ のサンプルを表示するには、このページの左上隅にある言語のフィルタ ボタン 言語のフィルタ をクリックします。

必要条件

プラットフォーム: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ

.NET Framework セキュリティ:

参照

Message クラス | Message メンバ | System.Messaging 名前空間 | Message | BodyStream | BodyType | Formatter | AppSpecific | Extension | UseEncryption | Send