MessagePropertyFilter.Authenticated Property

Reference

Definition

Namespace:: System.Messaging

Assembly:: System.Messaging.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 property bool Authenticated { bool get(); void set(bool value); };

[System.Messaging.MessagingDescription("MsgAuthenticated")]
public bool Authenticated { get; set; }

[<System.Messaging.MessagingDescription("MsgAuthenticated")>]
member this.Authenticated : bool with get, set

Public Property Authenticated As Boolean

Property Value

Boolean

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

Attributes: MessagingDescriptionAttribute

Examples

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

// Set the queue's MessageReadPropertyFilter property 
// to enable the message's Authenticated property.
queue->MessageReadPropertyFilter->Authenticated = 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 
// Authenticated property.
Console::WriteLine("Message.Authenticated: {0}", 
    orderMessage->Authenticated);

// Set the queue's MessageReadPropertyFilter property to enable the
// message's Authenticated property.
queue.MessageReadPropertyFilter.Authenticated = 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 Authenticated property.
Console.WriteLine("Message.Authenticated: {0}",
    orderMessage.Authenticated);

Remarks

The Authenticated property of the Message class is used by the receiving application to determine if authentication was requested. If authentication was requested and the message is in the queue, then the message is authenticated.

It is not possible to look at the properties of a message and determine whether a message failed authentication. Messages that fail authentication are discarded and are not delivered to the queue.

Applies to

Jaa