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)

public bool Authenticate { get; set; }
/** @property */
public boolean get_Authenticate ()

/** @property */
public void set_Authenticate (boolean value)

public function get Authenticate () : boolean

public function set Authenticate (value : boolean)

Property Value

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

Exception typeCondition

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

// Set the queue's Authenticate property value.
queue.set_Authenticate(true);
// Display the new value of the queue's Authenticate property.
Console.WriteLine("MessageQueue.Authenticate: {0}", 
    System.Convert.ToString(queue.get_Authenticate()));

  • Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see .

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft