MessagePropertyFilter Classe

Definizione

Controlla e seleziona le proprietà recuperate durante la lettura o la ricezione di messaggi da una coda.Controls and selects the properties that are retrieved when peeking or receiving messages from a message queue.

public ref class MessagePropertyFilter
[System.ComponentModel.TypeConverter(typeof(System.ComponentModel.ExpandableObjectConverter))]
public class MessagePropertyFilter
type MessagePropertyFilter = class
Public Class MessagePropertyFilter
Ereditarietà
MessagePropertyFilter
Attributi

Esempi

L'esempio di codice seguente invia due messaggi con priorità diverse alla coda e li recupera successivamente.The following code example sends two messages of different priorities to the queue, and retrieves them subsequently.


#using <system.dll>
#using <system.messaging.dll>

using namespace System;
using namespace System::Messaging;

/// <summary>
/// Provides a container class for the example.
/// </summary>
ref class MyNewQueue
{
   //**************************************************
   // Sends a string message to a queue.
   //**************************************************
public:
   void SendMessage( MessagePriority priority, String^ messageBody )
   {
      // Connect to a queue on the local computer.
      MessageQueue^ myQueue = gcnew MessageQueue( ".\\myQueue" );

      // Create a new message.
      Message^ myMessage = gcnew Message;
      if ( priority > MessagePriority::Normal )
      {
         myMessage->Body = "High Priority: {0}",messageBody;
      }
      else
      {
         myMessage->Body = messageBody;
      }

      // Set the priority of the message.
      myMessage->Priority = priority;

      // Send the Order to the queue.
      myQueue->Send( myMessage );

      return;
   }

   //**************************************************
   // Receives a message.
   //**************************************************
   void ReceiveMessage()
   {
      // Connect to the a queue on the local computer.
      MessageQueue^ myQueue = gcnew MessageQueue( ".\\myQueue" );

      // Set the queue to read the priority. By default, it
      // is not read.
      myQueue->MessageReadPropertyFilter->Priority = true;

      // Set the formatter to indicate body contains a String^.
      array<Type^>^ p = gcnew array<Type^>(1);
      p[ 0 ] = String::typeid;
      myQueue->Formatter = gcnew XmlMessageFormatter( p );
      try
      {
         // Receive and format the message. 
         Message^ myMessage = myQueue->Receive();

         // Display message information.
         Console::WriteLine( "Priority: {0}",
            myMessage->Priority );
         Console::WriteLine( "Body: {0}",
            myMessage->Body );
      }
      catch ( MessageQueueException^ ) 
      {
         // Handle Message Queuing exceptions.
      }
      // Handle invalid serialization format.
      catch ( InvalidOperationException^ e ) 
      {
         Console::WriteLine( e->Message );
      }

      // Catch other exceptions as necessary.

      return;
   }
};

//**************************************************
// Provides an entry point into the application.
//		 
// This example sends and receives a message from
// a queue.
//**************************************************
int main()
{
   // Create a new instance of the class.
   MyNewQueue^ myNewQueue = gcnew MyNewQueue;

   // Send messages to a queue.
   myNewQueue->SendMessage( MessagePriority::Normal, "First Message Body." );
   myNewQueue->SendMessage( MessagePriority::Highest, "Second Message Body." );

   // Receive messages from a queue.
   myNewQueue->ReceiveMessage();
   myNewQueue->ReceiveMessage();

   return 0;
}
using System;
using System.Messaging;

namespace MyProject
{

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

            // Send messages to a queue.
            myNewQueue.SendMessage(MessagePriority.Normal, "First Message Body.");
            myNewQueue.SendMessage(MessagePriority.Highest, "Second Message Body.");

            // Receive messages from a queue.
            myNewQueue.ReceiveMessage(); 
            myNewQueue.ReceiveMessage();

            return;
        }

        //**************************************************
        // Sends a string message to a queue.
        //**************************************************
        
        public void SendMessage(MessagePriority priority, string messageBody)
        {

            // Connect to a queue on the local computer.
            MessageQueue myQueue = new MessageQueue(".\\myQueue");

            // Create a new message.
            Message myMessage = new Message();

            if(priority > MessagePriority.Normal)
            {
                myMessage.Body = "High Priority: " + messageBody;
            }
            else
            {
                myMessage.Body = messageBody;
            }

            // Set the priority of the message.
            myMessage.Priority = priority;

            // Send the Order to the queue.
            myQueue.Send(myMessage);

            return;
        }

        //**************************************************
        // Receives a message.
        //**************************************************
        
        public  void ReceiveMessage()
        {
            // Connect to the a queue on the local computer.
            MessageQueue myQueue = new MessageQueue(".\\myQueue");

            // Set the queue to read the priority. By default, it
            // is not read.
            myQueue.MessageReadPropertyFilter.Priority = true;

            // Set the formatter to indicate body contains a string.
            myQueue.Formatter = new XmlMessageFormatter(new Type[]
                {typeof(string)});
            
            try
            {
                // Receive and format the message. 
                Message myMessage =	myQueue.Receive(); 

                // Display message information.
                Console.WriteLine("Priority: " + 
                    myMessage.Priority.ToString());
                Console.WriteLine("Body: " + 
                    myMessage.Body.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


'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()
         
         ' Send messages to a queue.
         myNewQueue.SendMessage(MessagePriority.Normal, "First Message Body.")
         myNewQueue.SendMessage(MessagePriority.Highest, "Second Message Body.")
         
         ' Receive messages from a queue.
         myNewQueue.ReceiveMessage()
         myNewQueue.ReceiveMessage()
         
         Return
      End Sub
      
      
      

      ' Sends a string message to a queue.

      Public Sub SendMessage(priority As MessagePriority, messageBody As String)
         
         ' Connect to a queue on the local computer.
         Dim myQueue As New MessageQueue(".\myQueue")
         
         ' Create a new message.
         Dim myMessage As New Message()
         
         If priority > MessagePriority.Normal Then
            myMessage.Body = "High Priority: " + messageBody
         Else
            myMessage.Body = messageBody
         End If 
         ' Set the priority of the message.
         myMessage.Priority = priority
         
         
         ' Send the Order to the queue.
         myQueue.Send(myMessage)
         
         Return
      End Sub
      
      
      

      ' Receives a message.

      Public Sub ReceiveMessage()
         ' Connect to the a queue on the local computer.
         Dim myQueue As New MessageQueue(".\myQueue")
         
         ' Set the queue to read the priority. By default, it
         ' is not read.
         myQueue.MessageReadPropertyFilter.Priority = True
         
         ' Set the formatter to indicate body contains a string.
         myQueue.Formatter = New XmlMessageFormatter(New Type() {GetType(String)})
         
         Try
            ' Receive and format the message. 
            Dim myMessage As Message = myQueue.Receive()
            
            ' Display message information.
            Console.WriteLine(("Priority: " + myMessage.Priority.ToString()))
            Console.WriteLine(("Body: " + myMessage.Body.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

L'impostazione di MessageQueuesuun' istanza controlla il set di proprietà che vengono recuperate durante la lettura o la ricezione di un messaggio. MessagePropertyFilterSetting the MessagePropertyFilter on a MessageQueue instance controls the set of properties that are retrieved when peeking or receiving a message. Il filtro viene impostato sull'istanza di MessageQueue che recupera le informazioni sul messaggio.The filter is set on the instance of MessageQueue that retrieves the message information. Quando si imposta un MessagePropertyFilter membro con valori booleani su false, si impedisce che le informazioni della proprietà Message associata vengano recuperate da MessageQueue.When you set a MessagePropertyFilter Boolean-valued member to false, you prevent the information of the associated Message property from being retrieved by the MessageQueue.

Esistono diverse proprietà di filtro che non sono valori booleani.There are several filter properties that are not Boolean values. Si tratta di valori integer che ottengono o impostano le dimensioni Message.Bodypredefinite Message.Extensiondi, Message.Labelo.They are integer values that get or set the default sizes of the Message.Body, Message.Extension, or Message.Label.

Il recupero di un set limitato di proprietà consente di migliorare le prestazioni in quanto le quantità minori di dati vengono trasferite dalla coda.Retrieving a limited set of properties helps improve performance because smaller amounts of data are transferred from the queue.

Quando si imposta una proprietà MessagePropertyFiltersu, viene indicato solo se tale proprietà viene recuperata quando viene ricevuto o visualizzato un messaggio.When setting a property on MessagePropertyFilter, you are only indicating whether that property is retrieved when a message is received or peeked. Non si sta modificando il valore della proprietà associata Messageper l'oggetto.You are not changing the associated property value for the Message.

Il MessagePropertyFilter costruttore imposta tutte le proprietà di filtro sui valori predefiniti, che per i valori booleani falseè.The MessagePropertyFilter constructor sets all filter properties to their default values, which for the Boolean values is false. Vedere l'argomento relativo al costruttore per i valori predefiniti assegnati alle proprietà con valori interi.See the constructor topic for the defaults assigned to the integer-valued properties.

Costruttori

MessagePropertyFilter()

Inizializza una nuova istanza della classe MessagePropertyFilter e imposta i valori predefiniti di tutte le proprietà.Initializes a new instance of the MessagePropertyFilter class and sets default values for all properties.

Proprietà

AcknowledgeType

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà AcknowledgeType quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve AcknowledgeType property information when receiving or peeking a message.

Acknowledgment

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà Acknowledgment quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve Acknowledgment property information when receiving or peeking a message.

AdministrationQueue

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà AdministrationQueue quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve AdministrationQueue property information when receiving or peeking a message.

AppSpecific

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà AppSpecific quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve AppSpecific property information when receiving or peeking a message.

ArrivedTime

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà ArrivedTime quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve ArrivedTime property information when receiving or peeking a message.

AttachSenderId

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà AttachSenderId quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve AttachSenderId property information when receiving or peeking a message.

Authenticated

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà Authenticated quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve Authenticated property information when receiving or peeking a message.

AuthenticationProviderName

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà AuthenticationProviderName quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve AuthenticationProviderName property information when receiving or peeking a message.

AuthenticationProviderType

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà AuthenticationProviderType quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve AuthenticationProviderType property information when receiving or peeking a message.

Body

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà Body quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve Body property information when receiving or peeking a message.

ConnectorType

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà ConnectorType quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve ConnectorType property information when receiving or peeking a message.

CorrelationId

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà CorrelationId quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve CorrelationId property information when receiving or peeking a message.

DefaultBodySize

Ottiene o imposta le dimensioni predefinite, in byte, del buffer del corpo.Gets or sets the size, in bytes, of the default body buffer.

DefaultExtensionSize

Ottiene o imposta le dimensioni, in byte, del buffer di estensione predefinito.Gets or sets the size, in bytes, of the default extension buffer.

DefaultLabelSize

Ottiene o imposta le dimensioni, in byte, del buffer dell'etichetta predefinita.Gets or sets the size, in bytes, of the default label buffer.

DestinationQueue

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà DestinationQueue quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve DestinationQueue property information when receiving or peeking a message.

DestinationSymmetricKey

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà DestinationSymmetricKey quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve DestinationSymmetricKey property information when receiving or peeking a message.

DigitalSignature

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà DigitalSignature quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve DigitalSignature property information when receiving or peeking a message.

EncryptionAlgorithm

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà EncryptionAlgorithm quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve EncryptionAlgorithm property information when receiving or peeking a message.

Extension

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà Extension quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve Extension property information when receiving or peeking a message.

HashAlgorithm

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà HashAlgorithm quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve HashAlgorithm property information when receiving or peeking a message.

Id

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà Id quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve Id property information when receiving or peeking a message.

IsFirstInTransaction

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà IsFirstInTransaction quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve IsFirstInTransaction property information when receiving or peeking a message.

IsLastInTransaction

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà IsLastInTransaction quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve IsLastInTransaction property information when receiving or peeking a message.

Label

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà Label quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve Label property information when receiving or peeking a message.

LookupId

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà LookupId quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve LookupId property information when receiving or peeking a message.

MessageType

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà MessageType quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve MessageType property information when receiving or peeking a message.

Priority

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà Priority quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve Priority property information when receiving or peeking a message.

Recoverable

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà Recoverable quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve Recoverable property information when receiving or peeking a message.

ResponseQueue

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà ResponseQueue quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve ResponseQueue property information when receiving or peeking a message.

SenderCertificate

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà SenderCertificate quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve SenderCertificate property information when receiving or peeking a message.

SenderId

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà SenderId quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve SenderId property information when receiving or peeking a message.

SenderVersion

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà SenderVersion quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve SenderVersion property information when receiving or peeking a message.

SentTime

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà SentTime quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve SentTime property information when receiving or peeking a message.

SourceMachine

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà SourceMachine quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve SourceMachine property information when receiving or peeking a message.

TimeToBeReceived

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà TimeToBeReceived quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve TimeToBeReceived property information when receiving or peeking a message.

TimeToReachQueue

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà TimeToReachQueue quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve TimeToReachQueue property information when receiving or peeking a message.

TransactionId

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà TransactionId quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve TransactionId property information when receiving or peeking a message.

TransactionStatusQueue

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà TransactionStatusQueue quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve TransactionStatusQueue property information when receiving or peeking a message.

UseAuthentication

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà UseAuthentication quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve UseAuthentication property information when receiving or peeking a message.

UseDeadLetterQueue

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà UseDeadLetterQueue quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve UseDeadLetterQueue property information when receiving or peeking a message.

UseEncryption

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà UseEncryption quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve UseEncryption property information when receiving or peeking a message.

UseJournalQueue

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà UseJournalQueue quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve UseJournalQueue property information when receiving or peeking a message.

UseTracing

Ottiene o imposta un valore che indica se recuperare le informazioni della proprietà UseTracing quando si riceve o si visualizza un messaggio.Gets or sets a value that indicates whether to retrieve UseTracing property information when receiving or peeking a message.

Metodi

ClearAll()

Imposta tutti i valori Boolean del filtro su false, in modo che nessuna proprietà del messaggio venga recuperata alla ricezione.Sets all Boolean filter values to false, so that no message properties are retrieved when receiving a message.

Clone()

Consente di creare una copia dei riferimenti dell'oggetto.Creates a shallow copy of the object.

Equals(Object)

Determina se l'oggetto specificato è uguale all'oggetto corrente.Determines whether the specified object is equal to the current object.

(Ereditato da Object)
GetHashCode()

Funge da funzione hash predefinita.Serves as the default hash function.

(Ereditato da Object)
GetType()

Ottiene l'oggetto Type dell'istanza corrente.Gets the Type of the current instance.

(Ereditato da Object)
MemberwiseClone()

Crea una copia superficiale dell'oggetto Object corrente.Creates a shallow copy of the current Object.

(Ereditato da Object)
SetAll()

Specifica di recuperare tutte le proprietà dei messaggi alla ricezione di un messaggio.Specifies to retrieve all message properties when receiving a message.

SetDefaults()

Imposta i valori di filtro delle proprietà comuni di Accodamento messaggi su true e le proprietà con Integer sui rispettivi valori predefiniti.Sets the filter values of common Message Queuing properties to true and the integer-valued properties to their default values.

ToString()

Restituisce una stringa che rappresenta l'oggetto corrente.Returns a string that represents the current object.

(Ereditato da Object)

Si applica a

Vedi anche