MessageEnumerator.RemoveCurrent Method (MessageQueueTransaction)

 
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.

Removes the current message from a transactional 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(
	MessageQueueTransaction transaction
)

Parameters

transaction
Type: System.Messaging.MessageQueueTransaction

The MessageQueueTransaction object that specifies the transaction in which the message will be removed.

Return Value

Type: System.Messaging.Message

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

Exception Condition
ArgumentNullException

The transaction parameter is null.

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

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: