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

.NET Framework
Available since 1.1
Return to top
Show: