XmlMessageFormatter Costruttori

Definizione

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

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

.NET Framework 4.8.1 e altre versioni
Prodotto Versioni
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

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 (string[] targetTypeNames);

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

Il valore del parametro targetTypeNames è null.

Esempio

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

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

.NET Framework 4.8.1 e altre versioni
Prodotto Versioni
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

XmlMessageFormatter(Type[])

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

public XmlMessageFormatter (Type[] targetTypes);

Parametri

targetTypes
Type[]

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

Eccezioni

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.

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.

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

.NET Framework 4.8.1 e altre versioni
Prodotto Versioni
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1