Message.Formatter プロパティ
アセンブリ: System.Messaging (system.messaging.dll 内)

Dim instance As Message Dim value As IMessageFormatter value = instance.Formatter instance.Formatter = value
public: property IMessageFormatter^ Formatter { IMessageFormatter^ get (); void set (IMessageFormatter^ value); }
/** @property */ public IMessageFormatter get_Formatter () /** @property */ public void set_Formatter (IMessageFormatter value)
public function get Formatter () : IMessageFormatter public function set Formatter (value : IMessageFormatter)
メッセージ本文に書き込むストリーム、またはメッセージ本文から読み取るストリームを生成する IMessageFormatter。既定値は XmlMessageFormatter です。


メッセージの読み取りと書き込みを行うときには Formatter プロパティを使います。メッセージがキューに送信されるときには、Body プロパティが書式指定子によってシリアル化され、メッセージ キューに送信できるストリームになります。キューから読み取るときには、メッセージ データが書式指定子によって逆シリアル化され、Body プロパティになります。
メッセージの内容を BodyStream プロパティに直接書き込む以外は、メッセージを送信する前に Formatter プロパティを設定します。MessageQueue インスタンスで Send メソッドが呼び出された場合は、Formatter プロパティに格納されている書式指定子を使用して、メッセージの本文がシリアル化されます。Formatter プロパティの値を指定せずにメッセージを送信した場合、書式指定子は既定値の XmlMessageFormatter に設定されます。
XmlMessageFormatter は疎結合であるため、この形式を使用する場合に、送信側と受信側のオブジェクト型が同じである必要はありません。ActiveXMessageFormatter と BinaryMessageFormatter は、データをシリアル化してバイナリ表現にします。ActiveXMessageFormatter は COM コンポーネントを送受信するときに使用されます。

BinaryMessageFormatter を使用してメッセージの本文を書式設定するコード例を次に示します。
Imports System Imports System.Messaging Imports System.Drawing Imports System.IO Namespace MyProj _ 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() ' Create a queue on the local computer. CreateQueue(".\myQueue") ' Send a message to a queue. myNewQueue.SendMessage() ' Receive a message from a queue. myNewQueue.ReceiveMessage() Return End Sub 'Main '************************************************** ' Creates a new queue. '************************************************** Public Shared Sub CreateQueue(queuePath As String) Try If Not MessageQueue.Exists(queuePath) Then MessageQueue.Create(queuePath) Else Console.WriteLine((queuePath + " already exists.")) End If Catch e As MessageQueueException Console.WriteLine(e.Message) End Try End Sub 'CreateQueue '************************************************** ' Sends an image to a queue, using the BinaryMessageFormatter. '************************************************** Public Sub SendMessage() Try ' Create a new bitmap. ' The file must be in the \bin\debug or \bin\retail folder, or ' you must give a full path to its location. Dim myImage As Image = Bitmap.FromFile("SentImage.bmp") ' Connect to a queue on the local computer. Dim myQueue As New MessageQueue(".\myQueue") Dim myMessage As New Message(myImage, New BinaryMessageFormatter()) ' Send the image to the queue. myQueue.Send(myMessage) Catch e As ArgumentException Console.WriteLine(e.Message) End Try Return End Sub 'SendMessage '************************************************** ' Receives a message containing an image. '************************************************** Public Sub ReceiveMessage() Try ' Connect to the a queue on the local computer. Dim myQueue As New MessageQueue(".\myQueue") ' Set the formatter to indicate body contains an Order. myQueue.Formatter = New BinaryMessageFormatter() ' Receive and format the message. Dim myMessage As System.Messaging.Message = myQueue.Receive() Dim myImage As Bitmap = CType(myMessage.Body, Bitmap) ' This will be saved in the \bin\debug or \bin\retail folder. myImage.Save("ReceivedImage.bmp", System.Drawing.Imaging.ImageFormat.Bmp) 'Catch ' Handle Message Queuing exceptions. ' Handle invalid serialization format. Catch e As InvalidOperationException Console.WriteLine(e.Message) Catch e As IOException End Try ' Handle file access exceptions. ' Catch other exceptions as necessary. Return End Sub 'ReceiveMessage End Class 'MyNewQueue End Namespace 'MyProj
using System; using System.Messaging; using System.Drawing; using System.IO; 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(); // Create a queue on the local computer. CreateQueue(".\\myQueue"); // Send a message to a queue. myNewQueue.SendMessage(); // Receive a message from a queue. myNewQueue.ReceiveMessage(); return; } //************************************************** // Creates a new queue. //************************************************** public static void CreateQueue(string queuePath) { try { if(!MessageQueue.Exists(queuePath)) { MessageQueue.Create(queuePath); } else { Console.WriteLine(queuePath + " already exists."); } } catch (MessageQueueException e) { Console.WriteLine(e.Message); } } //************************************************** // Sends an image to a queue, using the BinaryMessageFormatter. //************************************************** public void SendMessage() { try{ // Create a new bitmap. // The file must be in the \bin\debug or \bin\retail folder, or // you must give a full path to its location. Image myImage = Bitmap.FromFile("SentImage.bmp"); // Connect to a queue on the local computer. MessageQueue myQueue = new MessageQueue(".\\myQueue"); Message myMessage = new Message(myImage, new BinaryMessageFormatter()); // Send the image to the queue. myQueue.Send(myMessage); } catch(ArgumentException e) { Console.WriteLine(e.Message); } return; } //************************************************** // Receives a message containing an image. //************************************************** public void ReceiveMessage() { try { // Connect to the a queue on the local computer. MessageQueue myQueue = new MessageQueue(".\\myQueue"); // Set the formatter to indicate body contains an Order. myQueue.Formatter = new BinaryMessageFormatter(); // Receive and format the message. System.Messaging.Message myMessage = myQueue.Receive(); Bitmap myImage = (Bitmap)myMessage.Body; // This will be saved in the \bin\debug or \bin\retail folder. myImage.Save("ReceivedImage.bmp",System.Drawing.Imaging.ImageFormat.Bmp); } catch (MessageQueueException) { // Handle Message Queuing exceptions. } // Handle invalid serialization format. catch (InvalidOperationException e) { Console.WriteLine(e.Message); } catch (IOException e) { // Handle file access exceptions. } // Catch other exceptions as necessary. return; } } }
#using <system.dll> #using <system.messaging.dll> #using <system.drawing.dll> using namespace System; using namespace System::Messaging; using namespace System::Drawing; using namespace System::IO; /// <summary> /// Provides a container class for the example. /// </summary> ref class MyNewQueue { public: //************************************************* // Creates a new queue. //************************************************* static void CreateQueue( String^ queuePath ) { try { if ( !MessageQueue::Exists( queuePath ) ) { MessageQueue::Create( queuePath ); } else { Console::WriteLine( "{0} already exists.", queuePath ); } } catch ( MessageQueueException^ e ) { Console::WriteLine( e->Message ); } } //************************************************* // Sends an image to a queue, using the BinaryMessageFormatter. //************************************************* void SendMessage() { try { // Create a new bitmap. // The file must be in the \bin\debug or \bin\retail folder, or // you must give a full path to its location. Image^ myImage = Bitmap::FromFile( "SentImage::bmp" ); // Connect to a queue on the local computer. MessageQueue^ myQueue = gcnew MessageQueue( ".\\myQueue" ); Message^ myMessage = gcnew Message( myImage,gcnew BinaryMessageFormatter ); // Send the image to the queue. myQueue->Send( myMessage ); } catch ( ArgumentException^ e ) { Console::WriteLine( e->Message ); } return; } //************************************************* // Receives a message containing an image. //************************************************* void ReceiveMessage() { try { // Connect to the a queue on the local computer. MessageQueue^ myQueue = gcnew MessageQueue( ".\\myQueue" ); // Set the formatter to indicate body contains an Order. myQueue->Formatter = gcnew BinaryMessageFormatter; // Receive and format the message. Message^ myMessage = myQueue->Receive(); Bitmap^ myImage = static_cast<Bitmap^>(myMessage->Body); // This will be saved in the \bin\debug or \bin\retail folder. myImage->Save( "ReceivedImage::bmp", System::Drawing::Imaging::ImageFormat::Bmp ); } catch ( MessageQueueException^ ) { // Handle Message Queuing exceptions. } // Handle invalid serialization format. catch ( InvalidOperationException^ e ) { Console::WriteLine( e->Message ); } catch ( IOException^ e ) { // Handle file access exceptions. } // 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; // Create a queue on the local computer. MyNewQueue::CreateQueue( ".\\myQueue" ); // Send a message to a queue. myNewQueue->SendMessage(); // Receive a message from a queue. myNewQueue->ReceiveMessage(); return 0; }
package MyProject; import System.*; import System.Messaging.*; import System.Drawing.*; import System.IO.*; /// <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(); // Create a queue on the local computer. CreateQueue(".\\myQueue"); // Send a message to a queue. myNewQueue.SendMessage(); // Receive a message from a queue. myNewQueue.ReceiveMessage(); return; } //main //************************************************** // Creates a new queue. //************************************************** public static void CreateQueue(String queuePath) { try { if (!(MessageQueue.Exists(queuePath))) { MessageQueue.Create(queuePath); } else { Console.WriteLine(queuePath + " already exists."); } } catch (MessageQueueException e) { Console.WriteLine(e.get_Message()); } } //CreateQueue //************************************************** // Sends an image to a queue, using the BinaryMessageFormatter. //************************************************** public void SendMessage() { try { // Create a new bitmap. // The file must be in the \bin\debug or \bin\retail folder, or // you must give a full path to its location. Image myImage = Bitmap.FromFile("SentImage.bmp"); // Connect to a queue on the local computer. MessageQueue myQueue = new MessageQueue(".\\myQueue"); Message myMessage = new Message(myImage, new BinaryMessageFormatter()); // Send the image to the queue. myQueue.Send(myMessage); } catch (ArgumentException e) { Console.WriteLine(e.get_Message()); } return; } //SendMessage //************************************************** // Receives a message containing an image. //************************************************** public void ReceiveMessage() { try { // Connect to the a queue on the local computer. MessageQueue myQueue = new MessageQueue(".\\myQueue"); // Set the formatter to indicate body contains an Order. myQueue.set_Formatter(new BinaryMessageFormatter()); // Receive and format the message. System.Messaging.Message myMessage = myQueue.Receive(); Bitmap myImage = (Bitmap)myMessage.get_Body(); // This will be saved in the \bin\debug or \bin\retail folder. myImage.Save("ReceivedImage.bmp", System.Drawing.Imaging.ImageFormat.get_Bmp()); } catch (MessageQueueException exp) { // Handle Message Queuing exceptions. } // Handle invalid serialization format. catch (InvalidOperationException e) { Console.WriteLine(e.get_Message()); } catch (IOException e) { // Handle file access exceptions. } // Catch other exceptions as necessary. return; } //ReceiveMessage } //MyNewQueue
XmlMessageFormatter を使用してメッセージの本文を書式設定するコード例を次に示します。
Imports System Imports System.Messaging Imports System.Drawing Imports System.IO ' The following example ' sends to a queue and receives from a queue. Public Class Order Public orderId As Integer Public orderTime As DateTime End Class 'Order ' 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() ' Create a queue on the local computer. CreateQueue(".\myQueue") ' Send a message to a queue. myNewQueue.SendMessage() ' Receive a message from a queue. myNewQueue.ReceiveMessage() Return End Sub 'Main ' Creates a new queue. Public Shared Sub CreateQueue(queuePath As String) Try If Not MessageQueue.Exists(queuePath) Then MessageQueue.Create(queuePath) Else Console.WriteLine((queuePath + " already exists.")) End If Catch e As MessageQueueException Console.WriteLine(e.Message) End Try End Sub 'CreateQueue ' Sends an Order to a queue. Public Sub SendMessage() Try ' Create a new order and set values. Dim sentOrder As New Order() sentOrder.orderId = 3 sentOrder.orderTime = DateTime.Now ' Connect to a queue on the local computer. Dim myQueue As New MessageQueue(".\myQueue") ' Create the new order. Dim myMessage As New Message(sentOrder) ' Send the order to the queue. myQueue.Send(myMessage) Catch e As ArgumentException Console.WriteLine(e.Message) End Try Return End Sub 'SendMessage ' Receives a message containing an order. Public Sub ReceiveMessage() ' Connect to the a queue on the local computer. Dim myQueue As New MessageQueue(".\myQueue") ' Set the formatter to indicate body contains an Order. myQueue.Formatter = New XmlMessageFormatter(New Type() {GetType(Order)}) Try ' Receive and format the message. Dim myMessage As Message = myQueue.Receive() Dim myOrder As Order = CType(myMessage.Body, Order) ' Display message information. Console.WriteLine(("Order ID: " + myOrder.orderId.ToString())) Console.WriteLine(("Sent: " + myOrder.orderTime.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
using System; using System.Messaging; using System.Drawing; using System.IO; namespace MyProject { // The following example // sends to a queue and receives from a queue. public class Order { public int orderId; public DateTime orderTime; }; /// <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(); // Create a queue on the local computer. CreateQueue(".\\myQueue"); // Send a message to a queue. myNewQueue.SendMessage(); // Receive a message from a queue. myNewQueue.ReceiveMessage(); return; } //************************************************** // Creates a new queue. //************************************************** public static void CreateQueue(string queuePath) { try { if(!MessageQueue.Exists(queuePath)) { MessageQueue.Create(queuePath); } else { Console.WriteLine(queuePath + " already exists."); } } catch (MessageQueueException e) { Console.WriteLine(e.Message); } } //************************************************** // Sends an Order to a queue. //************************************************** public void SendMessage() { try { // Create a new order and set values. Order sentOrder = new Order(); sentOrder.orderId = 3; sentOrder.orderTime = DateTime.Now; // Connect to a queue on the local computer. MessageQueue myQueue = new MessageQueue(".\\myQueue"); // Create the new order. Message myMessage = new Message(sentOrder); // Send the order to the queue. myQueue.Send(myMessage); } catch(ArgumentException e) { Console.WriteLine(e.Message); } return; } //************************************************** // Receives a message containing an order. //************************************************** public void ReceiveMessage() { // Connect to the a queue on the local computer. MessageQueue myQueue = new MessageQueue(".\\myQueue"); // Set the formatter to indicate body contains an Order. myQueue.Formatter = new XmlMessageFormatter(new Type[] {typeof(MyProject.Order)}); try { // Receive and format the message. Message myMessage = myQueue.Receive(); Order myOrder = (Order)myMessage.Body; // Display message information. Console.WriteLine("Order ID: " + myOrder.orderId.ToString()); Console.WriteLine("Sent: " + myOrder.orderTime.ToString()); } catch (MessageQueueException) { // Handle Message Queuing exceptions. } // Handle invalid serialization format. catch (InvalidOperationException e) { Console.WriteLine(e.Message); } // Catch other exceptions as necessary. return; } } }
#using <system.dll> #using <system.messaging.dll> #using <system.drawing.dll> using namespace System; using namespace System::Messaging; using namespace System::Drawing; using namespace System::IO; ref class Order { public: int orderId; DateTime orderTime; }; ref class MyNewQueue { public: static void CreateQueue( String^ queuePath ) { try { if ( !MessageQueue::Exists( queuePath ) ) { MessageQueue::Create( queuePath ); } else { Console::WriteLine( "{0} already exists.", queuePath ); } } catch ( MessageQueueException^ e ) { Console::WriteLine( e->Message ); } } void SendMessage() { try { // Create a new order and set values. Order^ sentOrder = gcnew Order; sentOrder->orderId = 3; sentOrder->orderTime = DateTime::Now; // Connect to a queue on the local computer. MessageQueue^ myQueue = gcnew MessageQueue( ".\\myQueue" ); // Create the new order. Message^ myMessage = gcnew Message( sentOrder ); // Send the order to the queue. myQueue->Send( myMessage ); } catch ( ArgumentException^ e ) { Console::WriteLine( e->Message ); } return; } void ReceiveMessage() { // Connect to the a queue on the local computer. MessageQueue^ myQueue = gcnew MessageQueue( ".\\myQueue" ); // Set the formatter to indicate body contains an Order. array<Type^>^p = gcnew array<Type^>(1); p[ 0 ] = Order::typeid; myQueue->Formatter = gcnew XmlMessageFormatter( p ); try { // Receive and format the message. Message^ myMessage = myQueue->Receive(); Order^ myOrder = dynamic_cast<Order^>(myMessage->Body); // Display message information. Console::WriteLine( "Order ID: {0}", myOrder->orderId ); Console::WriteLine( "Sent: {0}", myOrder->orderTime ); } 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 = gcnew MyNewQueue; // Create a queue on the local computer. MyNewQueue::CreateQueue( ".\\myQueue" ); // Send a message to a queue. myNewQueue->SendMessage(); // Receive a message from a queue. myNewQueue->ReceiveMessage(); return 0; }
package MyProject; import System.*; import System.Messaging.*; import System.Drawing.*; import System.IO.*; // The following example // sends to a queue and receives from a queue. public class Order { public int orderId; public DateTime orderTime; } //Order /// <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(); // Create a queue on the local computer. CreateQueue(".\\myQueue"); // Send a message to a queue. myNewQueue.SendMessage(); // Receive a message from a queue. myNewQueue.ReceiveMessage(); return; } //main //************************************************** // Creates a new queue. //************************************************** public static void CreateQueue(String queuePath) { try { if (!(MessageQueue.Exists(queuePath))) { MessageQueue.Create(queuePath); } else { Console.WriteLine(queuePath + " already exists."); } } catch (MessageQueueException e) { Console.WriteLine(e.get_Message()); } } //CreateQueue //************************************************** // Sends an Order to a queue. //************************************************** public void SendMessage() { try { // Create a new order and set values. Order sentOrder = new Order(); sentOrder.orderId = 3; sentOrder.orderTime = DateTime.get_Now(); // Connect to a queue on the local computer. MessageQueue myQueue = new MessageQueue(".\\myQueue"); // Create the new order. Message myMessage = new Message(sentOrder); // Send the order to the queue. myQueue.Send(myMessage); } catch (ArgumentException e) { Console.WriteLine(e.get_Message()); } return; } //SendMessage //************************************************** // Receives a message containing an order. //************************************************** public void ReceiveMessage() { // Connect to the a queue on the local computer. MessageQueue myQueue = new MessageQueue(".\\myQueue"); // Set the formatter to indicate body contains an Order. myQueue.set_Formatter(new XmlMessageFormatter(new Type[] { MyProject.Order.class.ToType() })); try { // Receive and format the message. Message myMessage = myQueue.Receive(); Order myOrder = (Order)myMessage.get_Body(); // Display message information. Console.WriteLine("Order ID: " + Convert.ToString(myOrder.orderId)); Console.WriteLine("Sent: " + myOrder.orderTime.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


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 によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。


Weblioに収録されているすべての辞書からMessage.Formatter プロパティを検索する場合は、下記のリンクをクリックしてください。

- Message.Formatter プロパティのページへのリンク