MessageEnumerator.RemoveCurrent Method (MessageQueueTransactionType)

 

Removes the current message from a queue and returns the message to the calling application. There is no timeout specified for a message to arrive in the queue.

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

public Message RemoveCurrent(
	MessageQueueTransactionType transactionType
)

Parameters

transactionType
Type: System.Messaging.MessageQueueTransactionType

One of the MessageQueueTransactionType values, describing the type of transaction context to associate with the message.

Return Value

Type: System.Messaging.Message

A Message that references the first message available in the queue.

Exception Condition
InvalidEnumArgumentException

The transactionType parameter is not one of the MessageQueueTransactionType members.

RemoveCurrent removes and returns the message at the cursor's current location, using a transaction context defined by the transactionType parameter.

Specify Automatic for the transactionType parameter if there is already an external transaction context attached to the thread that you want to use to receive the message. Specify Single if you want to receive the message as a single internal transaction. You can specify None if you want to receive a message from a transactional queue outside of a transaction context.

If you are using queue journaling, removing the message causes a copy to be kept in the journal queue, just as the MessageQueue class's Receive method does.

When working with transactional queues, a rollback of a transaction causes any messages removed by a call to RemoveCurrent to be returned to the queue. The removal is not irreversible until the transaction is committed.

When you remove the current message, the cursor is moved to the next message. You do not have to call MoveNext after calling RemoveCurrent.

.NET Framework
Available since 1.1
Return to top
Show: