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.

Exception Condition
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.

.NET Framework
Available since 1.1
Return to top
Show: