MessageQueue::Authenticate Property
Gets or sets a value that indicates whether the queue accepts only authenticated messages.
Assembly: System.Messaging (in System.Messaging.dll)
public: [MessagingDescriptionAttribute("MQ_Authenticate")] property bool Authenticate { bool get(); void set(bool value); }
Property Value
Type: System::Booleantrue if the queue accepts only authenticated messages; otherwise, false. The default is false.
| Exception | Condition |
|---|---|
| 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);
Available since 1.1