Export (0) Print
Expand All

MessagePropertyFilter.Authenticated Property

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

Namespace:  System.Messaging
Assembly:  System.Messaging (in System.Messaging.dll)

[MessagingDescriptionAttribute("MsgAuthenticated")]
public bool Authenticated { get; set; }

Property Value

Type: System.Boolean
true to receive Message.Authenticated information; otherwise, false. The default is false.

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.

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

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft