XmlMessageFormatter Construtores

Referência

Definição

Namespace:: System.Messaging

Assembly:: System.Messaging.dll

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Inicializa uma nova instância da classe XmlMessageFormatter.

Sobrecargas

XmlMessageFormatter()	Inicializa uma nova instância da classe XmlMessageFormatter, sem tipos de destino definidos.
XmlMessageFormatter(String[])	Inicializa uma nova instância da classe XmlMessageFormatter, definindo os tipos de destino passados como uma matriz de valores de cadeia de caracteres (totalmente qualificados).
XmlMessageFormatter(Type[])	Inicializa uma nova instância da classe XmlMessageFormatter, definindo tipos de destino transmitidos como uma matriz de tipos de objeto.

XmlMessageFormatter()

Inicializa uma nova instância da classe XmlMessageFormatter, sem tipos de destino definidos.

public:
 XmlMessageFormatter();

public XmlMessageFormatter ();

Public Sub New ()

Comentários

Essa sobrecarga do construtor é usada com mais frequência ao gravar na fila, pois os tipos de destino não são necessários ao gravar.

Para ler uma mensagem de uma fila usando uma instância do XmlMessageFormatter criada usando esse construtor, você deve definir as TargetTypeNames propriedades ou TargetTypes para que o formatador saiba quais tipos tentar desserializar.

Quando você cria um novo MessageQueue, uma instância padrão XmlMessageFormatter é criada, sem os tipos de destino definidos. Assim como acontece com um formatador criado usando esse construtor, você deve definir tipos de destino para essa instância de formatador se quiser ler da fila.

Aplica-se a

XmlMessageFormatter(String[])

Inicializa uma nova instância da classe XmlMessageFormatter, definindo os tipos de destino passados como uma matriz de valores de cadeia de caracteres (totalmente qualificados).

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())

Parâmetros

targetTypeNames: String[]

Uma matriz do tipo String que especifica o conjunto dos possíveis tipos que serão desserializados pelo formatador da mensagem fornecida. Esses valores devem ser totalmente qualificados, por exemplo, “MyNamespace.MyOrders, MyOrdersAssemblyName”.

Exceções

ArgumentNullException

O parâmetro targetTypeNames é null.

Exemplos

#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

Comentários

Os construtores com parâmetros de tipo de destino são usados com mais frequência ao ler da fila. Ao escrever, não é necessário especificar tipos de destino.

Essa sobrecarga do XmlMessageFormatter construtor define a TargetTypeNames propriedade como os valores de matriz passados por meio do targetTypeNames parâmetro . Definir essa propriedade permite que um MessageQueue usando essa XmlMessageFormatter instância leia mensagens que contêm objetos de determinados tipos.

TargetTypeNames As propriedades e TargetTypes informam ao formatador quais esquemas tentar corresponder ao desserializar uma mensagem. Isso permite que o formatador interprete o corpo da mensagem.

A instância serializada no corpo da mensagem deve estar em conformidade com um dos esquemas representados na matriz de tipos. Quando você lê a mensagem usando o Receive método , o método cria um objeto do tipo que corresponde ao esquema identificado e lê o corpo da mensagem nele.

Apenas uma das duas propriedades precisa ser definida ao ler da fila, mas você pode definir ambas. O conjunto de tipos é o conjunto combinado das duas propriedades. A decisão de qual usar é específica para seu aplicativo. Se o corpo da mensagem contiver um tipo cujo esquema não corresponda a nenhum dos tipos na matriz de qualquer propriedade, uma exceção será gerada no tempo de leitura.

Aplica-se a

XmlMessageFormatter(Type[])

Inicializa uma nova instância da classe XmlMessageFormatter, definindo tipos de destino transmitidos como uma matriz de tipos de objeto.

public:
 XmlMessageFormatter(cli::array <Type ^> ^ targetTypes);

public XmlMessageFormatter (Type[] targetTypes);

new System.Messaging.XmlMessageFormatter : Type[] -> System.Messaging.XmlMessageFormatter

Public Sub New (targetTypes As Type())

Parâmetros

targetTypes: Type[]

Uma matriz do tipo Type que especifica o conjunto dos possíveis tipos que serão desserializados pelo formatador da mensagem fornecida.

Exceções

ArgumentNullException

O parâmetro targetTypes é null.

Comentários

Os construtores com parâmetros de tipo de destino são usados com mais frequência ao ler da fila. Ao escrever, não é necessário especificar tipos de destino.

Essa sobrecarga do XmlMessageFormatter construtor define a TargetTypes propriedade como os valores de matriz passados por meio do targetTypes parâmetro . Definir essa propriedade permite que um MessageQueue usando essa XmlMessageFormatter instância leia mensagens que contêm objetos dos tipos determinados.

TargetTypeNames As propriedades e TargetTypes informam ao formatador quais esquemas tentar corresponder ao desserializar uma mensagem. Isso permite que o formatador interprete o corpo da mensagem.

Ao especificar em vez de TargetTypes , a existência do TargetTypeNamestipo é verificada em tempo de compilação em vez de tempo de leitura, reduzindo a possibilidade de erro. TargetTypeNames requer que cada entrada seja totalmente qualificada, especificando o nome do assembly. Além disso, ao trabalhar com várias versões simultâneas, o número de versão também deve ser acrescentado ao nome do tipo de destino.

Ao usar TargetTypes, você pode adicionar cada objeto (por exemplo, MyClass) à lista de maneira demonstrada pelo código C# a seguir.

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

Aplica-se a

Compartilhar via

XmlMessageFormatter Construtores

Definição

Sobrecargas

XmlMessageFormatter()

Comentários

Aplica-se a

XmlMessageFormatter(String[])

Parâmetros

Exceções

Exemplos

Comentários

Aplica-se a

XmlMessageFormatter(Type[])

Parâmetros

Exceções

Comentários

Aplica-se a

Recursos adicionais