XmlMessageFormatter Costruttori

Riferimento

Definizione

Spazio dei nomi:: System.Messaging

Assembly:: System.Messaging.dll

Importante

Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.

Inizializza una nuova istanza della classe XmlMessageFormatter.

Overload

XmlMessageFormatter()	Inizializza una nuova istanza della classe XmlMessageFormatter senza tipi di destinazione impostati.
XmlMessageFormatter(String[])	Inizializza una nuova istanza della classe XmlMessageFormatter impostando i tipi di destinazione passati come matrice di valori di stringa (completamente qualificati).
XmlMessageFormatter(Type[])	Inizializza una nuova istanza della classe XmlMessageFormatter impostando i tipi di destinazione passati come matrice di tipi di oggetti.

XmlMessageFormatter()

Inizializza una nuova istanza della classe XmlMessageFormatter senza tipi di destinazione impostati.

public:
 XmlMessageFormatter();

public XmlMessageFormatter ();

Public Sub New ()

Commenti

Questo overload del costruttore viene usato più di frequente durante la scrittura nella coda, poiché i tipi di destinazione non sono necessari durante la scrittura.

Per leggere un messaggio da una coda usando un'istanza di XmlMessageFormatter creata usando questo costruttore, è necessario impostare le TargetTypeNames proprietà o TargetTypes in modo che il formattatore sappia quali tipi tentare di deserializzare.

Quando si crea una nuova MessageQueueistanza di , viene creata un'istanza predefinita XmlMessageFormatter senza i tipi di destinazione impostati. Come per un formattatore creato usando questo costruttore, è necessario impostare i tipi di destinazione per l'istanza del formattatore se si vuole leggere dalla coda.

Si applica a

XmlMessageFormatter(String[])

Inizializza una nuova istanza della classe XmlMessageFormatter impostando i tipi di destinazione passati come matrice di valori di stringa (completamente qualificati).

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

Parametri

targetTypeNames: String[]

Matrice di tipo String che specifica l'insieme di tipi possibili che verranno deserializzati tramite il formattatore dal messaggio fornito. Tali valori devono essere completamente qualificati, ad esempio "MyNamespace.MyOrders, MyOrdersAssemblyName".

Eccezioni

ArgumentNullException

Il valore del parametro targetTypeNames è null.

Esempio

#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

Commenti

I costruttori con parametri di tipo di destinazione vengono usati più di frequente durante la lettura dalla coda. Quando si scrive, non è necessario specificare i tipi di destinazione.

Questo overload del costruttore imposta la TargetTypeNames proprietà sui valori della XmlMessageFormatter matrice passati tramite il targetTypeNames parametro . L'impostazione di questa proprietà consente a un MessageQueue uso di questa XmlMessageFormatter istanza di leggere i messaggi contenenti oggetti di tipi specificati.

Entrambe le TargetTypeNames proprietà e TargetTypes indicano al formattatore gli schemi da tentare di corrispondere durante la deserializzazione di un messaggio. Ciò consente al formattatore di interpretare il corpo del messaggio.

L'istanza serializzata nel corpo del messaggio deve essere conforme a uno degli schemi rappresentati nella matrice di tipi. Quando si legge il messaggio usando il Receive metodo, il metodo crea un oggetto del tipo che corrisponde allo schema identificato e legge il corpo del messaggio in esso.

Solo una delle due proprietà deve essere impostata durante la lettura dalla coda, ma è possibile impostare entrambe le proprietà. Il set di tipi è il set combinato delle due proprietà. La decisione di quale usare è specifica per l'applicazione. Se il corpo del messaggio contiene un tipo il cui schema non corrisponde a nessuno dei tipi nella matrice per entrambe le proprietà, verrà generata un'eccezione in fase di lettura.

Si applica a

XmlMessageFormatter(Type[])

Inizializza una nuova istanza della classe XmlMessageFormatter impostando i tipi di destinazione passati come matrice di tipi di oggetti.

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

public XmlMessageFormatter (Type[] targetTypes);

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

Public Sub New (targetTypes As Type())

Parametri

targetTypes: Type[]

Matrice di tipo Type che specifica l'insieme di tipi possibili che verranno deserializzati tramite il formattatore dal messaggio fornito.

Eccezioni

ArgumentNullException

Il valore del parametro targetTypes è null.

Commenti

I costruttori con parametri di tipo di destinazione vengono usati più di frequente durante la lettura dalla coda. Quando si scrive, non è necessario specificare i tipi di destinazione.

Questo overload del costruttore imposta la TargetTypes proprietà sui valori della XmlMessageFormatter matrice passati tramite il targetTypes parametro . L'impostazione di questa proprietà consente a un MessageQueue uso di questa XmlMessageFormatter istanza di leggere i messaggi contenenti oggetti dei tipi specificati.

Quando si specifica TargetTypes anziché TargetTypeNames, l'esistenza del tipo viene controllata in fase di compilazione anziché tempo di lettura, riducendo la possibilità di errore. TargetTypeNames richiede che ogni voce sia completa, specificando il nome dell'assembly. Inoltre, quando si utilizzano più versioni simultanee, il numero di versione deve essere aggiunto anche al nome del tipo di destinazione.

Quando si usa TargetTypes, è possibile aggiungere ogni oggetto ,ad esempio , MyClassall'elenco in modo illustrato dal codice C# seguente.

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

Si applica a

XmlMessageFormatter Costruttori

Definizione

Overload

XmlMessageFormatter()

Commenti

Si applica a

XmlMessageFormatter(String[])

Parametri

Eccezioni

Esempio

Commenti

Si applica a

XmlMessageFormatter(Type[])

Parametri

Eccezioni

Commenti

Si applica a

Commenti e suggerimenti

Risorse aggiuntive