MessagePropertyFilter MessagePropertyFilter MessagePropertyFilter MessagePropertyFilter Class

Definición

Controla y selecciona las propiedades que se recuperan al leer en un mensaje o recibir mensajes de una cola de mensajes.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
Herencia
MessagePropertyFilterMessagePropertyFilterMessagePropertyFilterMessagePropertyFilter
Atributos

Ejemplos

El siguiente ejemplo de código envía dos mensajes con prioridades diferentes a la cola y recuperarlas posteriormente.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
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 'Main
      
      
      

      ' 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 'SendMessage
      
      
      

      ' 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 'ReceiveMessage
   End Class 'MyNewQueue

Comentarios

Establecer el MessagePropertyFilter en un MessageQueue instancia controla el conjunto de propiedades que se recuperan al leerlo o recibir un mensaje.Setting the MessagePropertyFilter on a MessageQueue instance controls the set of properties that are retrieved when peeking or receiving a message. El filtro está establecido en la instancia de MessageQueue que recupera la información del mensaje.The filter is set on the instance of MessageQueue that retrieves the message information. Al establecer un MessagePropertyFilter miembros con valores booleanos a false, evitar la información del asociado Message propiedad desde que se va a recuperar el 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.

Hay varias propiedades de filtro que no son valores booleanos.There are several filter properties that are not Boolean values. Son valores enteros que obtención o establecen los tamaños predeterminados de la Message.Body, Message.Extension, o Message.Label.They are integer values that get or set the default sizes of the Message.Body, Message.Extension, or Message.Label.

Recuperar un conjunto limitado de propiedades le ayuda a mejorar el rendimiento porque pequeñas cantidades de datos se transfieren de la cola.Retrieving a limited set of properties helps improve performance because smaller amounts of data are transferred from the queue.

Al establecer una propiedad en MessagePropertyFilter, sólo se indica si esa propiedad se recupera al recibir un mensaje o leerlo.When setting a property on MessagePropertyFilter, you are only indicating whether that property is retrieved when a message is received or peeked. No se cambia el valor de propiedad asociado para el Message.You are not changing the associated property value for the Message.

El MessagePropertyFilter constructor establece todas las propiedades de filtro en sus valores predeterminados, que para los valores booleanos es false.The MessagePropertyFilter constructor sets all filter properties to their default values, which for the Boolean values is false. Vea el tema de constructor para los valores predeterminados asignados a las propiedades con valores enteros.See the constructor topic for the defaults assigned to the integer-valued properties.

Constructores

MessagePropertyFilter() MessagePropertyFilter() MessagePropertyFilter() MessagePropertyFilter()

Inicializa una nueva instancia de la clase MessagePropertyFilter y establece valores predeterminados en todas las propiedades.Initializes a new instance of the MessagePropertyFilter class and sets default values for all properties.

Propiedades

AcknowledgeType AcknowledgeType AcknowledgeType AcknowledgeType

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad AcknowledgeType al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve AcknowledgeType property information when receiving or peeking a message.

Acknowledgment Acknowledgment Acknowledgment Acknowledgment

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad Acknowledgment al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve Acknowledgment property information when receiving or peeking a message.

AdministrationQueue AdministrationQueue AdministrationQueue AdministrationQueue

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad AdministrationQueue al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve AdministrationQueue property information when receiving or peeking a message.

AppSpecific AppSpecific AppSpecific AppSpecific

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad AppSpecific al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve AppSpecific property information when receiving or peeking a message.

ArrivedTime ArrivedTime ArrivedTime ArrivedTime

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad ArrivedTime al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve ArrivedTime property information when receiving or peeking a message.

AttachSenderId AttachSenderId AttachSenderId AttachSenderId

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad AttachSenderId al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve AttachSenderId property information when receiving or peeking a message.

Authenticated Authenticated Authenticated Authenticated

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad Authenticated al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve Authenticated property information when receiving or peeking a message.

AuthenticationProviderName AuthenticationProviderName AuthenticationProviderName AuthenticationProviderName

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad AuthenticationProviderName al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve AuthenticationProviderName property information when receiving or peeking a message.

AuthenticationProviderType AuthenticationProviderType AuthenticationProviderType AuthenticationProviderType

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad AuthenticationProviderType al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve AuthenticationProviderType property information when receiving or peeking a message.

Body Body Body Body

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad Body al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve Body property information when receiving or peeking a message.

ConnectorType ConnectorType ConnectorType ConnectorType

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad ConnectorType al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve ConnectorType property information when receiving or peeking a message.

CorrelationId CorrelationId CorrelationId CorrelationId

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad CorrelationId al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve CorrelationId property information when receiving or peeking a message.

DefaultBodySize DefaultBodySize DefaultBodySize DefaultBodySize

Obtiene o establece el tamaño, en bytes, del búfer de cuerpo predeterminado.Gets or sets the size, in bytes, of the default body buffer.

DefaultExtensionSize DefaultExtensionSize DefaultExtensionSize DefaultExtensionSize

Obtiene o establece el tamaño, en bytes, del búfer de extensión predeterminado.Gets or sets the size, in bytes, of the default extension buffer.

DefaultLabelSize DefaultLabelSize DefaultLabelSize DefaultLabelSize

Obtiene o establece el tamaño, en bytes, del búfer de etiqueta predeterminado.Gets or sets the size, in bytes, of the default label buffer.

DestinationQueue DestinationQueue DestinationQueue DestinationQueue

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad DestinationQueue al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve DestinationQueue property information when receiving or peeking a message.

DestinationSymmetricKey DestinationSymmetricKey DestinationSymmetricKey DestinationSymmetricKey

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad DestinationSymmetricKey al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve DestinationSymmetricKey property information when receiving or peeking a message.

DigitalSignature DigitalSignature DigitalSignature DigitalSignature

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad DigitalSignature al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve DigitalSignature property information when receiving or peeking a message.

EncryptionAlgorithm EncryptionAlgorithm EncryptionAlgorithm EncryptionAlgorithm

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad EncryptionAlgorithm al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve EncryptionAlgorithm property information when receiving or peeking a message.

Extension Extension Extension Extension

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad Extension al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve Extension property information when receiving or peeking a message.

HashAlgorithm HashAlgorithm HashAlgorithm HashAlgorithm

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad HashAlgorithm al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve HashAlgorithm property information when receiving or peeking a message.

Id Id Id Id

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad Id al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve Id property information when receiving or peeking a message.

IsFirstInTransaction IsFirstInTransaction IsFirstInTransaction IsFirstInTransaction

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad IsFirstInTransaction al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve IsFirstInTransaction property information when receiving or peeking a message.

IsLastInTransaction IsLastInTransaction IsLastInTransaction IsLastInTransaction

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad IsLastInTransaction al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve IsLastInTransaction property information when receiving or peeking a message.

Label Label Label Label

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad Label al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve Label property information when receiving or peeking a message.

LookupId LookupId LookupId LookupId

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad LookupId al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve LookupId property information when receiving or peeking a message.

MessageType MessageType MessageType MessageType

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad MessageType al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve MessageType property information when receiving or peeking a message.

Priority Priority Priority Priority

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad Priority al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve Priority property information when receiving or peeking a message.

Recoverable Recoverable Recoverable Recoverable

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad Recoverable al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve Recoverable property information when receiving or peeking a message.

ResponseQueue ResponseQueue ResponseQueue ResponseQueue

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad ResponseQueue al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve ResponseQueue property information when receiving or peeking a message.

SenderCertificate SenderCertificate SenderCertificate SenderCertificate

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad SenderCertificate al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve SenderCertificate property information when receiving or peeking a message.

SenderId SenderId SenderId SenderId

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad SenderId al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve SenderId property information when receiving or peeking a message.

SenderVersion SenderVersion SenderVersion SenderVersion

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad SenderVersion al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve SenderVersion property information when receiving or peeking a message.

SentTime SentTime SentTime SentTime

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad SentTime al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve SentTime property information when receiving or peeking a message.

SourceMachine SourceMachine SourceMachine SourceMachine

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad SourceMachine al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve SourceMachine property information when receiving or peeking a message.

TimeToBeReceived TimeToBeReceived TimeToBeReceived TimeToBeReceived

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad TimeToBeReceived al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve TimeToBeReceived property information when receiving or peeking a message.

TimeToReachQueue TimeToReachQueue TimeToReachQueue TimeToReachQueue

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad TimeToReachQueue al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve TimeToReachQueue property information when receiving or peeking a message.

TransactionId TransactionId TransactionId TransactionId

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad TransactionId al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve TransactionId property information when receiving or peeking a message.

TransactionStatusQueue TransactionStatusQueue TransactionStatusQueue TransactionStatusQueue

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad TransactionStatusQueue al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve TransactionStatusQueue property information when receiving or peeking a message.

UseAuthentication UseAuthentication UseAuthentication UseAuthentication

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad UseAuthentication al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve UseAuthentication property information when receiving or peeking a message.

UseDeadLetterQueue UseDeadLetterQueue UseDeadLetterQueue UseDeadLetterQueue

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad UseDeadLetterQueue al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve UseDeadLetterQueue property information when receiving or peeking a message.

UseEncryption UseEncryption UseEncryption UseEncryption

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad UseEncryption al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve UseEncryption property information when receiving or peeking a message.

UseJournalQueue UseJournalQueue UseJournalQueue UseJournalQueue

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad UseJournalQueue al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve UseJournalQueue property information when receiving or peeking a message.

UseTracing UseTracing UseTracing UseTracing

Obtiene o establece un valor que indica si se debe recuperar información de la propiedad UseTracing al recibir un mensaje o leerlo.Gets or sets a value that indicates whether to retrieve UseTracing property information when receiving or peeking a message.

Métodos

ClearAll() ClearAll() ClearAll() ClearAll()

Establece todos los valores de filtro booleanos en false, de modo que no se recuperen las propiedades de un mensaje cuando éste se recibe.Sets all Boolean filter values to false, so that no message properties are retrieved when receiving a message.

Clone() Clone() Clone() Clone()

Crea una copia superficial del objeto.Creates a shallow copy of the object.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determina si el objeto especificado es igual al objeto actual.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Sirve como la función hash predeterminada.Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crea una copia superficial del objeto Object actual.Creates a shallow copy of the current Object.

(Inherited from Object)
SetAll() SetAll() SetAll() SetAll()

Especifica que, cuando se recibe un mensaje, se deben recuperar todas sus propiedades.Specifies to retrieve all message properties when receiving a message.

SetDefaults() SetDefaults() SetDefaults() SetDefaults()

Establece los valores de filtrado de las propiedades frecuentes de Message Queuing en true y las propiedades con valores enteros en sus valores predeterminados.Sets the filter values of common Message Queuing properties to true and the integer-valued properties to their default values.

ToString() ToString() ToString() ToString()

Devuelve una cadena que representa el objeto actual.Returns a string that represents the current object.

(Inherited from Object)

Se aplica a

Consulte también: