This documentation is archived and is not being maintained.

MessagePropertyFilter.UseAuthentication Property

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

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

[MessagingDescriptionAttribute("MsgUseAuthentication")]
public bool UseAuthentication { get; set; }

Property Value

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

The UseAuthentication property of the Message class specifies whether the message needs to be 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 UseAuthentication property.

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

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

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Show: