MessageQueueTransaction Class

 

Provides a Message Queuing internal transaction.

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

System::Object
  System.Messaging::MessageQueueTransaction

public ref class MessageQueueTransaction : IDisposable

NameDescription
System_CAPS_pubmethodMessageQueueTransaction()

Initializes a new instance of the MessageQueueTransaction class.

NameDescription
System_CAPS_pubpropertyStatus

Gets the status of the transaction.

NameDescription
System_CAPS_pubmethodAbort()

Rolls back the pending internal transaction.

System_CAPS_pubmethodBegin()

Begins a new Message Queuing internal transaction.

System_CAPS_pubmethodCommit()

Commits a pending internal transaction.

System_CAPS_pubmethodDispose()

Releases all resources used by the MessageQueueTransaction.

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the MessageQueueTransaction and optionally releases the managed resources.

System_CAPS_pubmethodEquals(Object^)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

This API supports the product infrastructure and is not intended to be used directly from your code. Releases the resources held by the current instance.(Overrides Object::Finalize().)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

To send or receive a message as part of a transaction, you can use the MessageQueueTransaction class to create a transaction and pass it to an overload of the MessageQueue::Send method or the MessageQueue::Receive method that takes a transaction parameter. Messages sent as part of a transaction must be sent to transactional queues. Messages received from transactional queues must be received using a specified transaction.

In addition to the Receive method, you can receive messages with a specified identifier or specified correlation identifier. See the ReceiveById and ReceiveByCorrelationId methods for more information about selectively receiving messages from transactional queues.

Messages sent to transactional queues are removed if the transaction is committed. Similarly, messages received from transactional queues are returned to the queue if the transaction is rolled back.

If you instantiate a MessageQueueTransaction and pass it to an applicable overload of the Send method or Receive method to send a message to a non-transactional queue or receive a message from a non-transactional queue, the method throws an exception that indicates "Wrong Transaction Usage."

[Visual Basic]

MessageQueueTransaction is threading apartment aware, so if your apartment state is STA, you cannot use the transaction in multiple threads. Visual Basic sets the state of the main thread to STA, so you must apply the MTAThreadAttribute in the Main subroutine. Otherwise, sending a transactional message using another thread throws a MessageQueueException exception. You apply the MTAThreadAttribute by using the following fragment.

<System.MTAThreadAttribute>
 public sub Main()

.NET Framework
Available since 1.1

This type is thread safe.

Return to top
Show: