Sdílet prostřednictvím


XmlMessageFormatter Konstruktory

Definice

Inicializuje novou instanci XmlMessageFormatter třídy.

Přetížení

Name Description
XmlMessageFormatter()

Inicializuje novou instanci XmlMessageFormatter třídy bez sady cílových typů.

XmlMessageFormatter(String[])

Inicializuje novou instanci XmlMessageFormatter třídy a nastaví cílové typy předané jako pole (plně kvalifikované) řetězcové hodnoty.

XmlMessageFormatter(Type[])

Inicializuje novou instanci XmlMessageFormatter třídy a nastaví cílové typy předané jako pole typů objektů.

XmlMessageFormatter()

Inicializuje novou instanci XmlMessageFormatter třídy bez sady cílových typů.

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

Poznámky

Toto přetížení konstruktoru se používá nejčastěji při zápisu do fronty, protože cílové typy nejsou při zápisu nutné.

Chcete-li číst zprávu z fronty pomocí instance XmlMessageFormatter vytvořené pomocí tohoto konstruktoru, je nutné nastavit TargetTypeNames nebo TargetTypes vlastnosti tak, aby formátovací modul věděl, jaké typy se mají pokusit deserializovat.

Když vytvoříte novou MessageQueueinstanci, vytvoří se výchozí XmlMessageFormatter instance bez sady cílových typů. Stejně jako u formátovače vytvořeného pomocí tohoto konstruktoru je nutné nastavit cílové typy pro tuto instanci formátovače, pokud chcete číst z fronty.

Platí pro

XmlMessageFormatter(String[])

Inicializuje novou instanci XmlMessageFormatter třídy a nastaví cílové typy předané jako pole (plně kvalifikované) řetězcové hodnoty.

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

Parametry

targetTypeNames
String[]

Pole typu String , které určuje sadu možných typů, které budou deserializovány formátovačem ze zprávy. Tyto hodnoty musí být plně kvalifikované, například MyNamespace.MyOrders, MyOrdersAssemblyName.

Výjimky

Parametr targetTypeNames je null.

Příklady

#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

Poznámky

Konstruktory s parametry cílového typu se nejčastěji používají při čtení z fronty. Při psaní není nutné zadávat cílové typy.

Toto přetížení konstruktoru XmlMessageFormatterTargetTypeNames nastaví vlastnost na hodnoty pole předávané prostřednictvím parametru targetTypeNames . Nastavení této vlastnosti umožňuje MessageQueue použití této XmlMessageFormatter instance ke čtení zpráv obsahujících objekty daného typu.

TargetTypeNames Formátovací modul i TargetTypes vlastnosti říkají, jaká schémata se mají při deserializaci zprávy shodovat. Díky tomu může formátovací modul interpretovat text zprávy.

Instance serializovaná v textu zprávy musí splňovat jedno ze schémat reprezentovaných v poli typů. Při čtení zprávy pomocí Receive metody vytvoří metoda objekt typu, který odpovídá identifikovanému schématu a přečte do něj text zprávy.

Při čtení z fronty je potřeba nastavit pouze jednu ze dvou vlastností, ale obojí můžete nastavit. Sada typů je kombinovaná sada ze dvou vlastností. Rozhodnutí, které z nich se má použít, je specifické pro vaši aplikaci. Pokud text zprávy obsahuje typ, jehož schéma neodpovídá žádnému z typů v poli pro některou vlastnost, bude vyvolán výjimka při čtení.

Platí pro

XmlMessageFormatter(Type[])

Inicializuje novou instanci XmlMessageFormatter třídy a nastaví cílové typy předané jako pole typů objektů.

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

Parametry

targetTypes
Type[]

Pole typu Type , které určuje sadu možných typů, které budou deserializovány formátovačem ze zprávy.

Výjimky

Parametr targetTypes je null.

Poznámky

Konstruktory s parametry cílového typu se nejčastěji používají při čtení z fronty. Při psaní není nutné zadávat cílové typy.

Toto přetížení konstruktoru XmlMessageFormatterTargetTypes nastaví vlastnost na hodnoty pole předávané prostřednictvím parametru targetTypes . Nastavení této vlastnosti umožňuje MessageQueue pomocí této XmlMessageFormatter instance číst zprávy obsahující objekty daného typu.

TargetTypeNames Formátovací modul i TargetTypes vlastnosti říkají, jaká schémata se mají při deserializaci zprávy shodovat. Díky tomu může formátovací modul interpretovat text zprávy.

Instance serializovaná v textu zprávy musí splňovat jedno ze schémat reprezentovaných v poli typů. Při čtení zprávy pomocí Receive metody vytvoří metoda objekt typu, který odpovídá identifikovanému schématu a přečte do něj text zprávy.

Při čtení z fronty je potřeba nastavit pouze jednu ze dvou vlastností, ale obojí můžete nastavit. Sada typů je kombinovaná sada ze dvou vlastností. Rozhodnutí, které z nich se má použít, je specifické pro vaši aplikaci. Pokud text zprávy obsahuje typ, jehož schéma neodpovídá žádnému z typů v poli pro některou vlastnost, bude vyvolán výjimka při čtení.

Při zadávání TargetTypes namísto TargetTypeNames, existence typu je kontrolována v době kompilace namísto čtení času, což snižuje možnost chyby. TargetTypeNames vyžaduje, aby byla každá položka plně kvalifikovaná a zadala její název sestavení. Navíc při práci s více souběžnými verzemi musí být číslo verze také připojeno k názvu cílového typu.

Při použití TargetTypesmůžete každý objekt (například MyClass) přidat do seznamu způsobem, který ukazuje následující kód jazyka C#.

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

Platí pro