Message.Body プロパティ

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

Message.Body プロパティ

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

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

Visual Basic (宣言)

Public Property Body As
 Object

Visual Basic (使用法)

Dim instance As Message
Dim value As Object

value = instance.Body

instance.Body = value

C#

public Object Body { get; set;
 }

C++

public:
property Object^ Body {
    Object^ get ();
    void set (Object^ value);
}

J#

/** @property */
public Object get_Body ()

/** @property */
public void set_Body (Object value)

JScript

public function get Body
 () : Object

public function set Body
 (value : 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 に設定されます。

使用例

優先度が異なる 2 つのメッセージをキューに送信し、順番に取得するコード例を次に示します。

Visual Basic

Imports System
Imports System.Messaging


'Provides a container class for the example.
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()))
         
         
         
         ' 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

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 <system.dll>
#using <system.messaging.dll>

using namespace System;
using namespace System::Messaging;

/// <summary>
/// Provides a container class for the example.
/// </summary>
ref class MyNewQueue
{
   //**************************************************
   // Sends a string message to a queue.
   //**************************************************
public:
   void SendMessage( MessagePriority priority, String^ messageBody
 )
   {
      // Connect to a queue on the local computer.
      MessageQueue^ myQueue = gcnew MessageQueue( ".\\myQueue" );

      // Create a new message.
      Message^ myMessage = gcnew Message;
      if ( priority > MessagePriority::Normal )
      {
         myMessage->Body = "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;
   }

   //**************************************************
   // Receives a message.
   //**************************************************
   void ReceiveMessage()
   {
      // Connect to the a queue on the local computer.
      MessageQueue^ myQueue = gcnew 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^.
      array<Type^>^ p = gcnew array<Type^>(1);
      p[ 0 ] = String::typeid;
      myQueue->Formatter = gcnew XmlMessageFormatter( p );
      try
      {
         // Receive and format the message. 
         Message^ myMessage = myQueue->Receive();

         // Display message information.
         Console::WriteLine( "Priority: {0}",
            myMessage->Priority );
         Console::WriteLine( "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;
   }
};

//**************************************************
// Provides an entry point into the application.
//         
// This example sends and receives a message from
// a queue.
//**************************************************
int main()
{
   // Create a new instance of the class.
   MyNewQueue^ myNewQueue = gcnew 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 0;
}

J#

package MyProject;

import System.*;
import System.Messaging.*;

/// <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(String[]
 args)
    {
        // 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;
    } //main

    //**************************************************
    // 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.CompareTo(MessagePriority.Normal) > 0)
 {
            myMessage.set_Body("High Priority: " + messageBody);
        }
        else {
            myMessage.set_Body(messageBody);
        }
        // Set the priority of the message.
        myMessage.set_Priority(priority);
        // Send the Order to the queue.
        myQueue.Send(myMessage);
        return;
    } //SendMessage

    //**************************************************
    // 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.get_MessageReadPropertyFilter().set_Priority(true);
        // Set the formatter to indicate body contains a string.
        myQueue.set_Formatter(new XmlMessageFormatter(new
 Type[]
            { String.class.ToType() }));
        try {
            // Receive and format the message. 
            Message myMessage = myQueue.Receive();
            // Display message information.
            Console.WriteLine("Priority: " + myMessage.get_Priority().ToString());
            Console.WriteLine("Body: " + myMessage.get_Body().ToString());
        }
        catch (MessageQueueException exp) {
            // Handle Message Queuing exceptions.
        }            
        // Handle invalid serialization format.
        catch (InvalidOperationException e) {
            Console.WriteLine(e.get_Message());
        }
        // Catch other exceptions as necessary.
        return;
    } //ReceiveMessage
} //MyNewQueue

.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

参照

関連項目
Message クラス
Message メンバ
System.Messaging 名前空間
Message クラス
BodyStream
BodyType
Formatter
Message.AppSpecific プロパティ
Extension
UseEncryption
Send