MessagePropertyFilter 类

定义

控制并选择从消息队列查看或接收消息时检索的属性。Controls and selects the properties that are retrieved when peeking or receiving messages from a message queue.

public ref class MessagePropertyFilter
public ref class MessagePropertyFilter : ICloneable
[System.ComponentModel.TypeConverter(typeof(System.ComponentModel.ExpandableObjectConverter))]
public class MessagePropertyFilter
[System.ComponentModel.TypeConverter(typeof(System.ComponentModel.ExpandableObjectConverter))]
public class MessagePropertyFilter : ICloneable
[<System.ComponentModel.TypeConverter(typeof(System.ComponentModel.ExpandableObjectConverter))>]
type MessagePropertyFilter = class
[<System.ComponentModel.TypeConverter(typeof(System.ComponentModel.ExpandableObjectConverter))>]
type MessagePropertyFilter = class
    interface ICloneable
Public Class MessagePropertyFilter
Public Class MessagePropertyFilter
Implements ICloneable
继承
MessagePropertyFilter
属性
实现

示例

下面的代码示例将两个不同优先级的消息发送到队列,然后检索它们。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

注解

设置 MessagePropertyFilter 实例上的 MessageQueue 可控制查看或接收消息时检索的属性集。Setting the MessagePropertyFilter on a MessageQueue instance controls the set of properties that are retrieved when peeking or receiving a message. 在检索消息信息的实例上设置筛选器 MessageQueueThe filter is set on the instance of MessageQueue that retrieves the message information. MessagePropertyFilter 布尔值成员设置为时 false ,会阻止检索关联属性的信息 Message MessageQueueWhen you set a MessagePropertyFilter Boolean-valued member to false, you prevent the information of the associated Message property from being retrieved by the MessageQueue.

有些筛选器属性不是布尔值。There are several filter properties that are not Boolean values. 它们是用于获取或设置、或的默认大小的整数 Message.BodyMessage.Extension Message.LabelThey are integer values that get or set the default sizes of the Message.Body, Message.Extension, or Message.Label.

检索有限的属性集有助于提高性能,因为从队列传输的数据量更小。Retrieving a limited set of properties helps improve performance because smaller amounts of data are transferred from the queue.

在上设置属性时 MessagePropertyFilter ,仅指示在收到消息或扫视消息时是否检索该属性。When setting a property on MessagePropertyFilter, you are only indicating whether that property is retrieved when a message is received or peeked. 不会更改的关联属性值 MessageYou are not changing the associated property value for the Message.

MessagePropertyFilter构造函数将所有筛选器属性设置为其默认值,布尔值为 falseThe MessagePropertyFilter constructor sets all filter properties to their default values, which for the Boolean values is false. 有关赋给整数值属性的默认值,请参阅构造函数主题。See the constructor topic for the defaults assigned to the integer-valued properties.

构造函数

MessagePropertyFilter()

初始化 MessagePropertyFilter 类的新实例并为所有属性设置默认值。Initializes a new instance of the MessagePropertyFilter class and sets default values for all properties.

属性

AcknowledgeType

获取或设置一个值,该值指示接收或查看消息时是否检索 AcknowledgeType 属性信息。Gets or sets a value that indicates whether to retrieve AcknowledgeType property information when receiving or peeking a message.

Acknowledgment

获取或设置一个值,该值指示接收或查看消息时是否检索 Acknowledgment 属性信息。Gets or sets a value that indicates whether to retrieve Acknowledgment property information when receiving or peeking a message.

AdministrationQueue

获取或设置一个值,该值指示接收或查看消息时是否检索 AdministrationQueue 属性信息。Gets or sets a value that indicates whether to retrieve AdministrationQueue property information when receiving or peeking a message.

AppSpecific

获取或设置一个值,该值指示接收或查看消息时是否检索 AppSpecific 属性信息。Gets or sets a value that indicates whether to retrieve AppSpecific property information when receiving or peeking a message.

ArrivedTime

获取或设置一个值,该值指示接收或查看消息时是否检索 ArrivedTime 属性信息。Gets or sets a value that indicates whether to retrieve ArrivedTime property information when receiving or peeking a message.

AttachSenderId

获取或设置一个值,该值指示接收或查看消息时是否检索 AttachSenderId 属性信息。Gets or sets a value that indicates whether to retrieve AttachSenderId property information when receiving or peeking a message.

Authenticated

获取或设置一个值,该值指示接收或查看消息时是否检索 Authenticated 属性信息。Gets or sets a value that indicates whether to retrieve Authenticated property information when receiving or peeking a message.

AuthenticationProviderName

获取或设置一个值,该值指示接收或查看消息时是否检索 AuthenticationProviderName 属性信息。Gets or sets a value that indicates whether to retrieve AuthenticationProviderName property information when receiving or peeking a message.

AuthenticationProviderType

获取或设置一个值,该值指示接收或查看消息时是否检索 AuthenticationProviderType 属性信息。Gets or sets a value that indicates whether to retrieve AuthenticationProviderType property information when receiving or peeking a message.

Body

获取或设置一个值,该值指示接收或查看消息时是否检索 Body 属性信息。Gets or sets a value that indicates whether to retrieve Body property information when receiving or peeking a message.

ConnectorType

获取或设置一个值,该值指示接收或查看消息时是否检索 ConnectorType 属性信息。Gets or sets a value that indicates whether to retrieve ConnectorType property information when receiving or peeking a message.

CorrelationId

获取或设置一个值,该值指示接收或查看消息时是否检索 CorrelationId 属性信息。Gets or sets a value that indicates whether to retrieve CorrelationId property information when receiving or peeking a message.

DefaultBodySize

获取或设置默认主体缓冲区的大小(以字节为单位)。Gets or sets the size, in bytes, of the default body buffer.

DefaultExtensionSize

获取或设置默认扩展缓冲区的大小(以字节为单位)。Gets or sets the size, in bytes, of the default extension buffer.

DefaultLabelSize

获取或设置默认标签缓冲区的大小(以字节为单位)。Gets or sets the size, in bytes, of the default label buffer.

DestinationQueue

获取或设置一个值,该值指示接收或查看消息时是否检索 DestinationQueue 属性信息。Gets or sets a value that indicates whether to retrieve DestinationQueue property information when receiving or peeking a message.

DestinationSymmetricKey

获取或设置一个值,该值指示接收或查看消息时是否检索 DestinationSymmetricKey 属性信息。Gets or sets a value that indicates whether to retrieve DestinationSymmetricKey property information when receiving or peeking a message.

DigitalSignature

获取或设置一个值,该值指示接收或查看消息时是否检索 DigitalSignature 属性信息。Gets or sets a value that indicates whether to retrieve DigitalSignature property information when receiving or peeking a message.

EncryptionAlgorithm

获取或设置一个值,该值指示接收或查看消息时是否检索 EncryptionAlgorithm 属性信息。Gets or sets a value that indicates whether to retrieve EncryptionAlgorithm property information when receiving or peeking a message.

Extension

获取或设置一个值,该值指示接收或查看消息时是否检索 Extension 属性信息。Gets or sets a value that indicates whether to retrieve Extension property information when receiving or peeking a message.

HashAlgorithm

获取或设置一个值,该值指示接收或查看消息时是否检索 HashAlgorithm 属性信息。Gets or sets a value that indicates whether to retrieve HashAlgorithm property information when receiving or peeking a message.

Id

获取或设置一个值,该值指示接收或查看消息时是否检索 Id 属性信息。Gets or sets a value that indicates whether to retrieve Id property information when receiving or peeking a message.

IsFirstInTransaction

获取或设置一个值,该值指示接收或查看消息时是否检索 IsFirstInTransaction 属性信息。Gets or sets a value that indicates whether to retrieve IsFirstInTransaction property information when receiving or peeking a message.

IsLastInTransaction

获取或设置一个值,该值指示接收或查看消息时是否检索 IsLastInTransaction 属性信息。Gets or sets a value that indicates whether to retrieve IsLastInTransaction property information when receiving or peeking a message.

Label

获取或设置一个值,该值指示接收或查看消息时是否检索 Label 属性信息。Gets or sets a value that indicates whether to retrieve Label property information when receiving or peeking a message.

LookupId

获取或设置一个值,该值指示接收或查看消息时是否检索 LookupId 属性信息。Gets or sets a value that indicates whether to retrieve LookupId property information when receiving or peeking a message.

MessageType

获取或设置一个值,该值指示接收或查看消息时是否检索 MessageType 属性信息。Gets or sets a value that indicates whether to retrieve MessageType property information when receiving or peeking a message.

Priority

获取或设置一个值,该值指示接收或查看消息时是否检索 Priority 属性信息。Gets or sets a value that indicates whether to retrieve Priority property information when receiving or peeking a message.

Recoverable

获取或设置一个值,该值指示接收或查看消息时是否检索 Recoverable 属性信息。Gets or sets a value that indicates whether to retrieve Recoverable property information when receiving or peeking a message.

ResponseQueue

获取或设置一个值,该值指示接收或查看消息时是否检索 ResponseQueue 属性信息。Gets or sets a value that indicates whether to retrieve ResponseQueue property information when receiving or peeking a message.

SenderCertificate

获取或设置一个值,该值指示接收或查看消息时是否检索 SenderCertificate 属性信息。Gets or sets a value that indicates whether to retrieve SenderCertificate property information when receiving or peeking a message.

SenderId

获取或设置一个值,该值指示接收或查看消息时是否检索 SenderId 属性信息。Gets or sets a value that indicates whether to retrieve SenderId property information when receiving or peeking a message.

SenderVersion

获取或设置一个值,该值指示接收或查看消息时是否检索 SenderVersion 属性信息。Gets or sets a value that indicates whether to retrieve SenderVersion property information when receiving or peeking a message.

SentTime

获取或设置一个值,该值指示接收或查看消息时是否检索 SentTime 属性信息。Gets or sets a value that indicates whether to retrieve SentTime property information when receiving or peeking a message.

SourceMachine

获取或设置一个值,该值指示接收或查看消息时是否检索 SourceMachine 属性信息。Gets or sets a value that indicates whether to retrieve SourceMachine property information when receiving or peeking a message.

TimeToBeReceived

获取或设置一个值,该值指示接收或查看消息时是否检索 TimeToBeReceived 属性信息。Gets or sets a value that indicates whether to retrieve TimeToBeReceived property information when receiving or peeking a message.

TimeToReachQueue

获取或设置一个值,该值指示接收或查看消息时是否检索 TimeToReachQueue 属性信息。Gets or sets a value that indicates whether to retrieve TimeToReachQueue property information when receiving or peeking a message.

TransactionId

获取或设置一个值,该值指示接收或查看消息时是否检索 TransactionId 属性信息。Gets or sets a value that indicates whether to retrieve TransactionId property information when receiving or peeking a message.

TransactionStatusQueue

获取或设置一个值,该值指示接收或查看消息时是否检索 TransactionStatusQueue 属性信息。Gets or sets a value that indicates whether to retrieve TransactionStatusQueue property information when receiving or peeking a message.

UseAuthentication

获取或设置一个值,该值指示接收或查看消息时是否检索 UseAuthentication 属性信息。Gets or sets a value that indicates whether to retrieve UseAuthentication property information when receiving or peeking a message.

UseDeadLetterQueue

获取或设置一个值,该值指示接收或查看消息时是否检索 UseDeadLetterQueue 属性信息。Gets or sets a value that indicates whether to retrieve UseDeadLetterQueue property information when receiving or peeking a message.

UseEncryption

获取或设置一个值,该值指示接收或查看消息时是否检索 UseEncryption 属性信息。Gets or sets a value that indicates whether to retrieve UseEncryption property information when receiving or peeking a message.

UseJournalQueue

获取或设置一个值,该值指示接收或查看消息时是否检索 UseJournalQueue 属性信息。Gets or sets a value that indicates whether to retrieve UseJournalQueue property information when receiving or peeking a message.

UseTracing

获取或设置一个值,该值指示接收或查看消息时是否检索 UseTracing 属性信息。Gets or sets a value that indicates whether to retrieve UseTracing property information when receiving or peeking a message.

方法

ClearAll()

将所有布尔型筛选器的值设置为 false,以便在接收消息时不检索消息属性。Sets all Boolean filter values to false, so that no message properties are retrieved when receiving a message.

Clone()

创建对象的浅表副本。Creates a shallow copy of the object.

Equals(Object)

确定指定对象是否等于当前对象。Determines whether the specified object is equal to the current object.

(继承自 Object)
GetHashCode()

作为默认哈希函数。Serves as the default hash function.

(继承自 Object)
GetType()

获取当前实例的 TypeGets the Type of the current instance.

(继承自 Object)
MemberwiseClone()

创建当前 Object 的浅表副本。Creates a shallow copy of the current Object.

(继承自 Object)
SetAll()

指定在接收消息时检索消息的所有属性。Specifies to retrieve all message properties when receiving a message.

SetDefaults()

将公共消息队列属性的筛选器值设置为 true,并将整数值属性设置为它们的默认值。Sets the filter values of common Message Queuing properties to true and the integer-valued properties to their default values.

ToString()

返回表示当前对象的字符串。Returns a string that represents the current object.

(继承自 Object)

适用于

另请参阅