Message.Authenticated Property

Gets a value that indicates whether the message was authenticated.

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

public bool Authenticated { get; }
/** @property */
public boolean get_Authenticated ()

public function get Authenticated () : boolean

Not applicable.

Property Value

true if authentication was requested for the message when it entered the queue; otherwise, false.

Exception typeCondition

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

// 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}", 
    System.Convert.ToString(orderMessage.get_Authenticated()));

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show: