Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Message.Authenticated Property

Gets a value that indicates whether the message was authenticated.

Namespace:  System.Messaging
Assembly:  System.Messaging (in System.Messaging.dll)
[MessagingDescriptionAttribute("MsgAuthenticated")]
public bool Authenticated { get; }

Property Value

Type: System.Boolean
true if authentication was requested for the message when it entered the queue; otherwise, false.
ExceptionCondition
InvalidOperationException

The message has not been sent. This property can only be read on messages retrieved from a queue.

-or-

The message queue is filtered to ignore the Authenticated property.

The Authenticated property is used only by the application while it is interacting with the message and trying to determine if authentication was requested. If the message is in the queue, the message was authenticated. Conversely, if the Authenticated property is true, the receiving Queue Manager authenticated the message when it received that message.

You cannot determine if a message failed authentication by looking at its properties. Message Queuing discards messages that fail authentication before they are delivered to the queue. However, you can request that an acknowledgment message be sent if a delivery failure prevents the message from arriving in the queue.

The following code example displays the value of a message's Authenticated property.

// Display the value of the message's Authenticated property. 
// To view this property value, the queue's 
// MessageReadPropertyFilter.Authenticated property must be set to 
// true before the message is received.
Console.WriteLine("Authentication requested for this message: {0}",
    orderMessage.Authenticated.ToString());

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.