Export (0) Print
Expand All

MessageQueue.Authenticate Property

Gets or sets a value that indicates whether the queue accepts only authenticated messages.

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

[MessagingDescriptionAttribute("MQ_Authenticate")]
public bool Authenticate { get; set; }

Property Value

Type: System.Boolean
true if the queue accepts only authenticated messages; otherwise, false. The default is false.

ExceptionCondition
MessageQueueException

An error occurred when accessing a Message Queuing method.

Message authentication provides a way to ensure message integrity and to verify who sent the message. To request authentication, the sending application sets the message's authentication level.

When you set Authenticate to true, you are restricting access to the queue on the server, not only to this MessageQueue instance. All clients working against the same Message Queuing queue will be affected.

A queue that accepts only authenticated messages will reject a non-authenticated message. To request notification of message rejection, a sending application can set the AcknowledgeType property of the message. Because no other indication of message rejection exists, the sending application can lose the message unless you request that it be sent to the dead-letter queue.

The following table shows whether this property is available in various Workgroup modes.

Workgroup mode

Available

Local computer

Yes

Local computer and direct format name

Yes

Remote computer

No

Remote computer and direct format name

No

The following code example gets and sets the value of a message queue's Authenticate property.

// Set the queue's Authenticate property value.
queue.Authenticate = true;

// Display the new value of the queue's Authenticate property.
Console.WriteLine("MessageQueue.Authenticate: {0}", queue.Authenticate);

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.

Show:
© 2014 Microsoft