XmlMessageFormatter Konstruktorer

Definition

Initierar en ny instans av XmlMessageFormatter klassen.

Överlagringar

Name Description
XmlMessageFormatter()

Initierar en ny instans av XmlMessageFormatter klassen, utan att måltyper har angetts.

XmlMessageFormatter(String[])

Initierar en ny instans av XmlMessageFormatter klassen och anger måltyper som skickas som en matris med (fullständigt kvalificerade) strängvärden.

XmlMessageFormatter(Type[])

Initierar en ny instans av XmlMessageFormatter klassen och anger måltyper som skickas som en matris med objekttyper.

XmlMessageFormatter()

Initierar en ny instans av XmlMessageFormatter klassen, utan att måltyper har angetts.

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

Kommentarer

Den här överbelastningen av konstruktorn används oftast när du skriver till kön, eftersom måltyper inte krävs när du skriver.

Om du vill läsa ett meddelande från en kö med en instans av XmlMessageFormatter skapad med den här konstruktorn måste du ange TargetTypeNames egenskaperna eller TargetTypes så att formatören vet vilka typer som ska försöka deserialisera.

När du skapar en ny MessageQueueskapas en standardinstans XmlMessageFormatter utan att måltyperna har angetts. Precis som med en formaterare som skapats med den här konstruktorn måste du ange måltyper för den formateringsinstansen om du vill läsa från kön.

Gäller för

XmlMessageFormatter(String[])

Initierar en ny instans av XmlMessageFormatter klassen och anger måltyper som skickas som en matris med (fullständigt kvalificerade) strängvärden.

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

Parametrar

targetTypeNames
String[]

En matris av typen String som anger vilken uppsättning möjliga typer som ska deserialiseras av formatören från meddelandet. Dessa värden måste vara fullständigt kvalificerade, till exempel "MyNamespace.MyOrders, MyOrdersAssemblyName".

Undantag

Parametern targetTypeNames är null.

Exempel

#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

Kommentarer

Konstruktorerna med måltypsparametrar används oftast vid läsning från kön. När du skriver är det inte nödvändigt att ange måltyper.

Den här överlagringen XmlMessageFormatter av konstruktorn anger TargetTypeNames egenskapen till de matrisvärden som skickas via parametern targetTypeNames . Om du anger den här egenskapen kan du MessageQueue använda den här XmlMessageFormatter instansen för att läsa meddelanden som innehåller objekt av givna typer.

TargetTypeNames Både egenskaperna och TargetTypes talar om för formatören vilka scheman som ska försöka matcha när ett meddelande deserialiseras. Detta gör att formaterare kan tolka meddelandetexten.

Instansen som serialiseras i meddelandetexten måste följa något av schemana som representeras i typmatrisen. När du läser meddelandet med metoden Receive skapar metoden ett objekt av den typ som motsvarar schemat som identifierats och läser in meddelandetexten i det.

Endast en av de två egenskaperna måste anges när du läser från kön, men du kan ange båda. Uppsättningen med typer är den kombinerade uppsättningen från de två egenskaperna. Beslutet om vilken som ska användas är specifikt för ditt program. Om meddelandetexten innehåller en typ vars schema inte matchar någon av typerna i matrisen för någon av egenskaperna genereras ett undantag vid lästid.

Gäller för

XmlMessageFormatter(Type[])

Initierar en ny instans av XmlMessageFormatter klassen och anger måltyper som skickas som en matris med objekttyper.

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

Parametrar

targetTypes
Type[]

En matris av typen Type som anger vilken uppsättning möjliga typer som ska deserialiseras av formatören från meddelandet.

Undantag

Parametern targetTypes är null.

Kommentarer

Konstruktorerna med måltypsparametrar används oftast vid läsning från kön. När du skriver är det inte nödvändigt att ange måltyper.

Den här överlagringen XmlMessageFormatter av konstruktorn anger TargetTypes egenskapen till de matrisvärden som skickas via parametern targetTypes . Om du anger den här egenskapen kan du MessageQueue använda den här XmlMessageFormatter instansen för att läsa meddelanden som innehåller objekt av de angivna typerna.

TargetTypeNames Både egenskaperna och TargetTypes talar om för formatören vilka scheman som ska försöka matcha när ett meddelande deserialiseras. Detta gör att formaterare kan tolka meddelandetexten.

Instansen som serialiseras i meddelandetexten måste följa något av schemana som representeras i typmatrisen. När du läser meddelandet med metoden Receive skapar metoden ett objekt av den typ som motsvarar schemat som identifierats och läser in meddelandetexten i det.

Endast en av de två egenskaperna måste anges när du läser från kön, men du kan ange båda. Uppsättningen med typer är den kombinerade uppsättningen från de två egenskaperna. Beslutet om vilken som ska användas är specifikt för ditt program. Om meddelandetexten innehåller en typ vars schema inte matchar någon av typerna i matrisen för någon av egenskaperna genereras ett undantag vid lästid.

När du TargetTypes anger i stället TargetTypeNameskontrolleras typexistensen vid kompileringstid i stället för lästid, vilket minskar risken för fel. TargetTypeNames kräver att varje post är fullständigt kvalificerad och anger dess sammansättningsnamn. När du arbetar med flera samtidiga versioner måste versionsnumret också läggas till i måltypnamnet.

När du använder TargetTypeskan du lägga till varje objekt (till exempel MyClass) i listan på ett sätt som visas med följande C#-kod.

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

Gäller för