Message.IsFirstInTransaction Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets a value that indicates whether the message was the first message sent in a transaction.

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

[MessagingDescriptionAttribute("MsgIsFirstInTransaction")]
public bool IsFirstInTransaction { get; }

Property Value

Type: System.Boolean

true if the message was the first message sent in a transaction; otherwise, false.

Exception Condition
InvalidOperationException

The message has not been sent. This property can only be read on messages retrieved from a queue.

-or-

The message queue is filtered to ignore the IsFirstInTransaction property.

Receiving applications use the IsFirstInTransaction property to verify that a message was the first message sent in a single transaction to a single queue.

This property is available only with Message Queuing version 2.0 and later.

To verify transaction boundaries, you can use the IsFirstInTransaction property along with two other properties: IsLastInTransaction and TransactionId. Use the former to check whether a message was the last message sent in the transaction, and use the latter to retrieve the identifier of the transaction.

If only one message is sent in a transaction, the IsFirstInTransaction and IsLastInTransaction properties are both set to true.

The following code example displays the value of a message's IsFirstInTransaction property.

.NET Framework
Available since 1.1
Return to top
Show: