Edit

Share via


MessagePropertyFilter.EncryptionAlgorithm Property

Definition

Gets or sets a value that indicates whether to retrieve EncryptionAlgorithm property information when receiving or peeking a message.

public:
 property bool EncryptionAlgorithm { bool get(); void set(bool value); };
[System.Messaging.MessagingDescription("MsgEncryptionAlgorithm")]
public bool EncryptionAlgorithm { get; set; }
[<System.Messaging.MessagingDescription("MsgEncryptionAlgorithm")>]
member this.EncryptionAlgorithm : bool with get, set
Public Property EncryptionAlgorithm As Boolean

Property Value

true to receive EncryptionAlgorithm information; otherwise, false. The default is false.

Attributes

Examples

The following code example demonstrates the use of the EncryptionAlgorithm property.

// Set the queue's MessageReadPropertyFilter property 
// to enable the message's EncryptionAlgorithm property.
queue->MessageReadPropertyFilter->
    EncryptionAlgorithm = true;

// Peek at the message. Time out after ten seconds 
// in case the message was not delivered.
orderMessage = queue->Peek(TimeSpan::FromSeconds(10.0));

// Display the value of the message's 
// EncryptionAlgorithm property.
Console::WriteLine("Message.EncryptionAlgorithm: {0}", 
    orderMessage->EncryptionAlgorithm);
// Set the queue's MessageReadPropertyFilter property to enable the
// message's EncryptionAlgorithm property.
queue.MessageReadPropertyFilter.EncryptionAlgorithm = true;

// Peek at the message. Time out after ten seconds in case the message
// was not delivered.
orderMessage = queue.Peek(TimeSpan.FromSeconds(10.0));

// Display the value of the message's EncryptionAlgorithm property.
Console.WriteLine("Message.EncryptionAlgorithm: {0}",
    orderMessage.EncryptionAlgorithm);

Remarks

If a message is private, it is encrypted before it is sent and decrypted when it is received. The EncryptionAlgorithm property of the Message class specifies the algorithm used to encrypt the message body of a private message.

Applies to

See also