XmlMessageFormatter Конструкторы

Определение

Инициализирует новый экземпляр класса XmlMessageFormatter.Initializes a new instance of the XmlMessageFormatter class.

Перегрузки

XmlMessageFormatter()

Инициализирует новый экземпляр класса XmlMessageFormatter без набора типов целевых объектов.Initializes a new instance of the XmlMessageFormatter class, without target types set.

XmlMessageFormatter(String[])

Инициализирует новый экземпляр класса XmlMessageFormatter, устанавливая типы целевых объектов, передаваемых как массив (полностью определенных) строковых значений.Initializes a new instance of the XmlMessageFormatter class, setting target types passed in as an array of (fully qualified) string values.

XmlMessageFormatter(Type[])

Инициализирует новый экземпляр класса XmlMessageFormatter, устанавливая типы целевых объектов, передаваемых как массив типов объектов.Initializes a new instance of the XmlMessageFormatter class, setting target types passed in as an array of object types.

XmlMessageFormatter()

Инициализирует новый экземпляр класса XmlMessageFormatter без набора типов целевых объектов.Initializes a new instance of the XmlMessageFormatter class, without target types set.

public:
 XmlMessageFormatter();
public XmlMessageFormatter ();
Public Sub New ()

Комментарии

Эта перегрузка конструктора чаще всего используется при записи в очередь, так как типы целей не требуются при записи.This overload of the constructor is used most frequently when writing to the queue, as target types are not required when writing.

Для чтения сообщения из очереди с помощью экземпляра XmlMessageFormatter , созданного с помощью этого конструктора, необходимо TargetTypeNames задать свойства или TargetTypes , чтобы модуль форматирования знал, какие типы следует попытаться десериализовать.To read a message from a queue using an instance of XmlMessageFormatter created using this constructor, you must set the TargetTypeNames or TargetTypes properties so the formatter knows what types to attempt to deserialize.

При создании нового MessageQueueэкземпляр по умолчанию XmlMessageFormatter создается без задания целевых типов.When you create a new MessageQueue, a default XmlMessageFormatter instance is created, without the target types set. Как и при использовании модуля форматирования, созданного с помощью этого конструктора, необходимо задать типы целевых объектов для этого экземпляра модуля форматирования, если требуется считывать данные из очереди.As with a formatter created using this constructor, you must set target types for that formatter instance if you want to read from the queue.

XmlMessageFormatter(String[])

Инициализирует новый экземпляр класса XmlMessageFormatter, устанавливая типы целевых объектов, передаваемых как массив (полностью определенных) строковых значений.Initializes a new instance of the XmlMessageFormatter class, setting target types passed in as an array of (fully qualified) string values.

public:
 XmlMessageFormatter(cli::array <System::String ^> ^ targetTypeNames);
public XmlMessageFormatter (string[] targetTypeNames);
new System.Messaging.XmlMessageFormatter : string[] -> System.Messaging.XmlMessageFormatter
Public Sub New (targetTypeNames As String())

Параметры

targetTypeNames
String[]

Массив типа String, задающий набор возможных типов, десериализация которых будет выполняться модулем форматирования из предоставляемого сообщения.An array of type String that specifies the set of possible types that will be deserialized by the formatter from the message provided. Эти значения должны быть полностью определены, например, "MyNamespace.MyOrders, MyOrdersAssemblyName".These values must be fully qualified, for example, "MyNamespace.MyOrders, MyOrdersAssemblyName".

Исключения

Параметр targetTypeNames имеет значение null.The targetTypeNames parameter is null.

Примеры

#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;
}
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;
        }
    }
}
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

   
  
' 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
      
      

      ' 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
       
      

      ' 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
      
      
      
 
      ' 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
End Class

Комментарии

Конструкторы с параметрами целевого типа чаще всего используются при чтении из очереди.The constructors with target type parameters are most frequently used when reading from the queue. При записи не нужно указывать типы целевых объектов.When writing, it is not necessary to specify target types.

Эта перегрузка XmlMessageFormatter конструктора TargetTypeNames задает для свойства targetTypeNames значения массива, передаваемые через параметр.This overload of the XmlMessageFormatter constructor sets the TargetTypeNames property to the array values passed in through the targetTypeNames parameter. Задание этого свойства позволяет MessageQueue использовать этот XmlMessageFormatter экземпляр для чтения сообщений, содержащих объекты заданных типов.Setting this property enables a MessageQueue using this XmlMessageFormatter instance to read messages containing objects of given types.

И свойства, TargetTypes и указывают модулю форматирования, какие схемы следует пытаться сопоставить при десериализации сообщения. TargetTypeNamesBoth the TargetTypeNames and TargetTypes properties tell the formatter what schemas to attempt to match when deserializing a message. Это позволяет модулю форматирования интерпретировать текст сообщения.This allows the formatter to interpret the message body.

Экземпляр, сериализованный в тексте сообщения, должен соответствовать одной из схем, представленных в массиве типов.The instance serialized in the message body must comply with one of the schemas represented in the type array. При чтении сообщения с помощью Receive метода метод создает объект типа, соответствующий указанной схеме, и считывает в него текст сообщения.When you read the message using the Receive method, the method creates an object of the type that corresponds to the schema identified and reads the message body into it.

При чтении из очереди необходимо задать только одно из двух свойств, но можно задать и то, и другое.Only one of the two properties needs to be set when reading from the queue, but you can set both. Набор типов — это объединенный набор из двух свойств.The set of types is the combined set from the two properties. Решение о том, какой из них следует использовать, зависит от вашего приложения.The decision of which one to use is specific to your application. Если текст сообщения содержит тип, схема которого не соответствует ни одному из типов в массиве для любого из свойств, то во время чтения будет создано исключение.If the message body contains a type whose schema does not match any of the types in the array for either property, an exception will be thrown at read time.

XmlMessageFormatter(Type[])

Инициализирует новый экземпляр класса XmlMessageFormatter, устанавливая типы целевых объектов, передаваемых как массив типов объектов.Initializes a new instance of the XmlMessageFormatter class, setting target types passed in as an array of object types.

public:
 XmlMessageFormatter(cli::array <Type ^> ^ targetTypes);
public XmlMessageFormatter (Type[] targetTypes);
new System.Messaging.XmlMessageFormatter : Type[] -> System.Messaging.XmlMessageFormatter
Public Sub New (targetTypes As Type())

Параметры

targetTypes
Type[]

Массив типа Type, задающий набор возможных типов, десериализация которых будет выполняться модулем форматирования из предоставляемого сообщения.An array of type Type that specifies the set of possible types that will be deserialized by the formatter from the message provided.

Исключения

Параметр targetTypes имеет значение null.The targetTypes parameter is null.

Комментарии

Конструкторы с параметрами целевого типа чаще всего используются при чтении из очереди.The constructors with target type parameters are most frequently used when reading from the queue. При записи не нужно указывать типы целевых объектов.When writing, it is not necessary to specify target types.

Эта перегрузка XmlMessageFormatter конструктора TargetTypes задает для свойства targetTypes значения массива, передаваемые через параметр.This overload of the XmlMessageFormatter constructor sets the TargetTypes property to the array values passed in through the targetTypes parameter. Задание этого свойства позволяет MessageQueue использовать этот XmlMessageFormatter экземпляр для чтения сообщений, содержащих объекты заданных типов.Setting this property enables a MessageQueue using this XmlMessageFormatter instance to read messages containing objects of the given types.

И свойства, TargetTypes и указывают модулю форматирования, какие схемы следует пытаться сопоставить при десериализации сообщения. TargetTypeNamesBoth the TargetTypeNames and TargetTypes properties tell the formatter what schemas to attempt to match when deserializing a message. Это позволяет модулю форматирования интерпретировать текст сообщения.This allows the formatter to interpret the message body.

Экземпляр, сериализованный в тексте сообщения, должен соответствовать одной из схем, представленных в массиве типов.The instance serialized in the message body must comply with one of the schemas represented in the type array. При чтении сообщения с помощью Receive метода метод создает объект типа, соответствующий указанной схеме, и считывает в него текст сообщения.When you read the message using the Receive method, the method creates an object of the type that corresponds to the schema identified and reads the message body into it.

При чтении из очереди необходимо задать только одно из двух свойств, но можно задать и то, и другое.Only one of the two properties needs to be set when reading from the queue, but you can set both. Набор типов — это объединенный набор из двух свойств.The set of types is the combined set from the two properties. Решение о том, какой из них следует использовать, зависит от вашего приложения.The decision of which one to use is specific to your application. Если текст сообщения содержит тип, схема которого не соответствует ни одному из типов в массиве для любого из свойств, то во время чтения будет создано исключение.If the message body contains a type whose schema does not match any of the types in the array for either property, an exception will be thrown at read time.

При указании TargetTypes TargetTypeNames, а не, тип существование проверяется во время компиляции, а не на время чтения, уменьшая вероятность ошибки.When specifying TargetTypes rather than TargetTypeNames, type existence is checked at compile time rather than read time, reducing possibility for error. TargetTypeNamesтребует, чтобы каждая запись была полностью квалифицирована, указывая ее имя сборки.TargetTypeNames requires every entry to be fully qualified, specifying its assembly name. Кроме того, при работе с несколькими параллельными версиями номер версии также должен быть добавлен к имени целевого типа.Further, when working with multiple concurrent versions, the version number must also be appended to the target type name as well.

При использовании TargetTypesможно добавить каждый объект (например, MyClass) в список, как показано в следующем C# коде.When using TargetTypes, you can add each object (for example, MyClass) to the list in a way demonstrated by the following C# code.

TargetTypes = new Type[]{typeof(MyClass)}  

Применяется к