NGWS SDK Documentation  

This is preliminary documentation and subject to change.
To comment on this topic, please send us email at ngwssdk@microsoft.com. Thanks!

Message.Authenticated

Gets a value indicating whether the message was authenticated.

[Visual Basic]
Overridable Public ReadOnly Property Authenticated As Boolean
[C#]
public bool Authenticated {virtual get;}
[C++]
public: __property virtual bool get_Authenticated();
[JScript]
public function get Authenticated() : Boolean;

Property Value

true if authentication was requested on the message when it entered the queue; otherwise, false.

Exceptions

Exception Type Condition
InvalidOperationException The message queue is filtered not to read the Authenticated property.

-or-

The Authenticated property could not be set.

Remarks

Authenticated is only used by the application interacting with the message when trying to determine if authentication was requested. If the message is in the queue, then the message was authenticated . If Authenticated is true, then the receiving Queue Manager authenticated the message when it received the message.

Note   It is not possible to look at the properties of a message to determine if a message failed authentication. Messages that fail authentication are discarded and are not delivered to the queue.

If the receiving application needs only to check whether authentication was requested, it should use IsAuthenticated. However, if the receiving application also needs to check what type of signature was used during authentication, it must use MSMQMessage.ReceivedAuthenticationLevel.

See Also

Message Class | Message Members | System.Messaging Namespace | UseAuthentication | ConnectorType | Authenticate | DigitalSignature