XmlMessageFormatter Constructeurs

Référence

Définition

Espace de noms:: System.Messaging

Assembly:: System.Messaging.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Initialise une nouvelle instance de la classe XmlMessageFormatter.

Surcharges

XmlMessageFormatter()	Initialise une nouvelle instance de la classe XmlMessageFormatter, sans que des types cibles soient définis.
XmlMessageFormatter(String[])	Initialise une nouvelle instance de la classe XmlMessageFormatter en définissant des types cibles passés sous la forme d'un tableau de valeurs de chaîne (qualifiées complètes).
XmlMessageFormatter(Type[])	Initialise une nouvelle instance de la classe XmlMessageFormatter en définissant des types cibles passés sous la forme d'un tableau de types d'objets.

XmlMessageFormatter()

Initialise une nouvelle instance de la classe XmlMessageFormatter, sans que des types cibles soient définis.

public:
 XmlMessageFormatter();

public XmlMessageFormatter ();

Public Sub New ()

Remarques

Cette surcharge du constructeur est utilisée le plus fréquemment lors de l’écriture dans la file d’attente, car les types cibles ne sont pas obligatoires lors de l’écriture.

Pour lire un message d’une file d’attente à l’aide d’un instance de créé à l’aide de XmlMessageFormatter ce constructeur, vous devez définir les TargetTypeNames propriétés ou TargetTypes afin que le formateur sache quels types tenter de désérialiser.

Lorsque vous créez un nouveau MessageQueue, une instance par défaut XmlMessageFormatter est créée, sans les types cibles définis. Comme avec un formateur créé à l’aide de ce constructeur, vous devez définir des types cibles pour ce formateur instance si vous souhaitez lire à partir de la file d’attente.

S’applique à

XmlMessageFormatter(String[])

Initialise une nouvelle instance de la classe XmlMessageFormatter en définissant des types cibles passés sous la forme d'un tableau de valeurs de chaîne (qualifiées complètes).

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

Paramètres

targetTypeNames: String[]

Tableau de type String qui spécifie le jeu de types possibles qui seront désérialisés par le formateur à partir du message fourni. Ces valeurs doivent être qualifiées complètes (par exemple, "MyNamespace.MyOrders, MyOrdersAssemblyName").

Exceptions

ArgumentNullException

Le paramètre targetTypeNames a la valeur null.

Exemples

#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

Remarques

Les constructeurs avec des paramètres de type cible sont les plus fréquemment utilisés lors de la lecture à partir de la file d’attente. Lors de l’écriture, il n’est pas nécessaire de spécifier des types cibles.

Cette surcharge du XmlMessageFormatter constructeur définit la TargetTypeNames propriété sur les valeurs de tableau transmises via le targetTypeNames paramètre . La définition de cette propriété permet à un MessageQueue utilisateur de cette XmlMessageFormatter instance de lire des messages contenant des objets de types donnés.

TargetTypeNames Les propriétés et TargetTypes indiquent au formateur les schémas à essayer de faire correspondre lors de la désérialisation d’un message. Cela permet au formateur d’interpréter le corps du message.

Le instance sérialisé dans le corps du message doit être conforme à l’un des schémas représentés dans le tableau de types. Lorsque vous lisez le message à l’aide de la Receive méthode, la méthode crée un objet du type qui correspond au schéma identifié et lit le corps du message dans celui-ci.

Une seule des deux propriétés doit être définie lors de la lecture à partir de la file d’attente, mais vous pouvez définir les deux. L’ensemble de types est l’ensemble combiné des deux propriétés. Le choix de celui à utiliser est spécifique à votre application. Si le corps du message contient un type dont le schéma ne correspond à aucun des types du tableau pour l’une ou l’autre propriété, une exception est levée au moment de la lecture.

S’applique à

XmlMessageFormatter(Type[])

Initialise une nouvelle instance de la classe XmlMessageFormatter en définissant des types cibles passés sous la forme d'un tableau de types d'objets.

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

public XmlMessageFormatter (Type[] targetTypes);

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

Public Sub New (targetTypes As Type())

Paramètres

targetTypes: Type[]

Tableau de type Type qui spécifie le jeu de types possibles qui seront désérialisés par le formateur à partir du message fourni.

Exceptions

ArgumentNullException

Le paramètre targetTypes a la valeur null.

Remarques

Cette surcharge du XmlMessageFormatter constructeur définit la TargetTypes propriété sur les valeurs de tableau transmises via le targetTypes paramètre . La définition de cette propriété permet à un MessageQueue utilisateur de cette XmlMessageFormatter instance de lire des messages contenant des objets des types donnés.

Lorsque vous spécifiez TargetTypes plutôt que TargetTypeNames, l’existence du type est vérifiée au moment de la compilation plutôt qu’au moment de la lecture, ce qui réduit le risque d’erreur. TargetTypeNames exige que chaque entrée soit complète, en spécifiant son nom d’assembly. En outre, lorsque vous utilisez plusieurs versions simultanées, le numéro de version doit également être ajouté au nom du type cible.

Lorsque vous utilisez TargetTypes, vous pouvez ajouter chaque objet (par exemple, MyClass) à la liste d’une manière illustrée par le code C# suivant.

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

S’applique à

XmlMessageFormatter Constructeurs

Définition

Surcharges

XmlMessageFormatter()

Remarques

S’applique à

XmlMessageFormatter(String[])

Paramètres

Exceptions

Exemples

Remarques

S’applique à

XmlMessageFormatter(Type[])

Paramètres

Exceptions

Remarques

S’applique à

Commentaires

Ressources supplémentaires