MessageEnumerator.RemoveCurrent メソッド

定義

名前空間:

System.Messaging

アセンブリ:

System.Messaging.dll

キューから現在のメッセージを削除し、そのメッセージを呼び出し元アプリケーションに返します。 メッセージを削除すると、そのメッセージがキューから削除されます。

オーバーロード

RemoveCurrent()	トランザクション キューまたは非トランザクション キューから現在のメッセージを削除し、そのメッセージを呼び出し元アプリケーションに返します。 メッセージがキューに到達するまでのタイムアウトは指定されていません。
RemoveCurrent(MessageQueueTransaction)	トランザクション キューから現在のメッセージを削除し、そのメッセージを呼び出し元アプリケーションに返します。 メッセージがキューに到達するまでのタイムアウトは指定されていません。
RemoveCurrent(MessageQueueTransactionType)	キューから現在のメッセージを削除し、そのメッセージを呼び出し元アプリケーションに返します。 メッセージがキューに到達するまでのタイムアウトは指定されていません。
RemoveCurrent(TimeSpan)	キューから現在のメッセージを削除し、そのメッセージを呼び出し元アプリケーションに返します。 削除するメッセージがある場合、メソッドはすぐにメッセージを返します。 削除するメッセージがない場合、メソッドは新しいメッセージが到達するまで指定のタイムアウト時間だけ待機します。
RemoveCurrent(TimeSpan, MessageQueueTransaction)	トランザクション キューから現在のメッセージを削除し、そのメッセージを呼び出し元アプリケーションに返します。 削除するメッセージがある場合、メソッドはすぐにメッセージを返します。 削除するメッセージがない場合、メソッドは新しいメッセージが到達するまで指定のタイムアウト時間だけ待機します。
RemoveCurrent(TimeSpan, MessageQueueTransactionType)	キューから現在のメッセージを削除し、そのメッセージを呼び出し元アプリケーションに返します。 削除するメッセージがある場合、メソッドはすぐにメッセージを返します。 削除するメッセージがない場合、メソッドは新しいメッセージが到達するまで指定のタイムアウト時間だけ待機します。

注釈

これらのオーバーロードに関して説明されている動作は、 を使用してGetMessageEnumerator2インスタンスがMessageEnumerator取得された場合にのみ適用されます。 このメソッドは非推奨になったので、 を使用 GetMessageEnumerator して の MessageEnumerator インスタンスを取得しないでください。

RemoveCurrent()

トランザクション キューまたは非トランザクション キューから現在のメッセージを削除し、そのメッセージを呼び出し元アプリケーションに返します。 メッセージがキューに到達するまでのタイムアウトは指定されていません。

public:
 System::Messaging::Message ^ RemoveCurrent();

public System.Messaging.Message RemoveCurrent ();

member this.RemoveCurrent : unit -> System.Messaging.Message

Public Function RemoveCurrent () As Message

戻り値

Message

キューで利用できる最初のメッセージを参照する Message。

注釈

RemoveCurrent は、カーソルの現在の位置にあるメッセージを削除して返します。

キュージャーナリングを使用している場合、メッセージを削除すると、クラスReceiveのメソッドと同様に、コピーがジャーナル キューにMessageQueue保持されます。

現在のメッセージを削除すると、カーソルは次のメッセージに移動します。 を呼び出した後に を呼び出すMoveNextRemoveCurrent必要はありません。

トランザクション キューでこのオーバーロードを呼び出すと、メッセージ キューによって 1 つの内部トランザクションが作成されます。

こちらもご覧ください

• MoveNext()
• Current

RemoveCurrent(MessageQueueTransaction)

トランザクション キューから現在のメッセージを削除し、そのメッセージを呼び出し元アプリケーションに返します。 メッセージがキューに到達するまでのタイムアウトは指定されていません。

public:
 System::Messaging::Message ^ RemoveCurrent(System::Messaging::MessageQueueTransaction ^ transaction);

public System.Messaging.Message RemoveCurrent (System.Messaging.MessageQueueTransaction transaction);

member this.RemoveCurrent : System.Messaging.MessageQueueTransaction -> System.Messaging.Message

Public Function RemoveCurrent (transaction As MessageQueueTransaction) As Message

パラメーター

transaction

MessageQueueTransaction

メッセージが削除されるトランザクションを指定する MessageQueueTransaction オブジェクト。

戻り値

Message

キューで利用できる最初のメッセージを参照する Message。

例外

ArgumentNullException

transaction パラメーターが null です。

注釈

RemoveCurrent は、 パラメーターで定義された内部トランザクション コンテキストを使用して、カーソルの現在の場所にあるメッセージを transaction 削除して返します。

キュージャーナリングを使用している場合、メッセージを削除すると、クラスReceiveのメソッドと同様に、コピーがジャーナル キューにMessageQueue保持されます。

トランザクション キューを操作する場合、トランザクションをロールバックすると、呼び出し RemoveCurrent によって削除されたすべてのメッセージがキューに返されます。 トランザクションがコミットされるまで、削除は元に戻すことができません。

現在のメッセージを削除すると、カーソルは次のメッセージに移動します。 を呼び出した後に を呼び出すMoveNextRemoveCurrent必要はありません。

こちらもご覧ください

• MoveNext()
• Current
• MessageQueueTransaction

RemoveCurrent(MessageQueueTransactionType)

キューから現在のメッセージを削除し、そのメッセージを呼び出し元アプリケーションに返します。 メッセージがキューに到達するまでのタイムアウトは指定されていません。

public:
 System::Messaging::Message ^ RemoveCurrent(System::Messaging::MessageQueueTransactionType transactionType);

public System.Messaging.Message RemoveCurrent (System.Messaging.MessageQueueTransactionType transactionType);

member this.RemoveCurrent : System.Messaging.MessageQueueTransactionType -> System.Messaging.Message

Public Function RemoveCurrent (transactionType As MessageQueueTransactionType) As Message

パラメーター

transactionType

MessageQueueTransactionType

メッセージと関連付けるトランザクション コンテキストの種類を示す、MessageQueueTransactionType 値の 1 つ。

戻り値

Message

キューで利用できる最初のメッセージを参照する Message。

例外

InvalidEnumArgumentException

transactionType パラメーターが、MessageQueueTransactionType メンバーの 1 つではありません。

注釈

RemoveCurrent は、 パラメーターで定義されたトランザクション コンテキストを使用して、カーソルの現在の場所にあるメッセージを transactionType 削除して返します。

メッセージの受信に使用するtransactionTypeスレッドに外部トランザクション コンテキストが既にアタッチされている場合は、 パラメーターに を指定Automaticします。 メッセージを 1 つの内部トランザクションとして受信するかどうかを指定 Single します。 トランザクション コンテキストの外部のトランザクション キューからメッセージを受信するかどうかを指定 None できます。

キュージャーナリングを使用している場合、メッセージを削除すると、クラスReceiveのメソッドと同様に、コピーがジャーナル キューにMessageQueue保持されます。

トランザクション キューを操作する場合、トランザクションをロールバックすると、呼び出し RemoveCurrent によって削除されたすべてのメッセージがキューに返されます。 トランザクションがコミットされるまで、削除は元に戻すことができません。

現在のメッセージを削除すると、カーソルは次のメッセージに移動します。 を呼び出した後に を呼び出すMoveNextRemoveCurrent必要はありません。

こちらもご覧ください

• MoveNext()
• Current
• MessageQueueTransactionType

RemoveCurrent(TimeSpan)

キューから現在のメッセージを削除し、そのメッセージを呼び出し元アプリケーションに返します。 削除するメッセージがある場合、メソッドはすぐにメッセージを返します。 削除するメッセージがない場合、メソッドは新しいメッセージが到達するまで指定のタイムアウト時間だけ待機します。

public:
 System::Messaging::Message ^ RemoveCurrent(TimeSpan timeout);

public System.Messaging.Message RemoveCurrent (TimeSpan timeout);

member this.RemoveCurrent : TimeSpan -> System.Messaging.Message

Public Function RemoveCurrent (timeout As TimeSpan) As Message

パラメーター

timeout

TimeSpan

メッセージがキューに到達するまで待機する時間間隔。

戻り値

Message

キューで利用できる最初のメッセージを参照する Message。

例外

ArgumentException

timeout パラメーターに指定された値が無効です。

MessageQueueException

タイムアウトの時間が経過しました。

注釈

RemoveCurrent は、カーソルの現在の位置にあるメッセージを削除して返します。 カーソルがキューの末尾にある場合、メソッドのこのオーバーロードは、メッセージが使用可能になるまで待機するか、 timeout パラメーターで指定された間隔の有効期限が切れるまで待機します。

キュージャーナリングを使用している場合、メッセージを削除すると、クラスReceiveのメソッドと同様に、コピーがジャーナル キューにMessageQueue保持されます。

現在のメッセージを削除すると、カーソルは次のメッセージに移動します。 を呼び出した後に を呼び出すMoveNextRemoveCurrent必要はありません。

トランザクション キューでこのオーバーロードを呼び出すと、メッセージ キューによって 1 つの内部トランザクションが作成されます。

こちらもご覧ください

• MoveNext()
• Current

RemoveCurrent(TimeSpan, MessageQueueTransaction)

トランザクション キューから現在のメッセージを削除し、そのメッセージを呼び出し元アプリケーションに返します。 削除するメッセージがある場合、メソッドはすぐにメッセージを返します。 削除するメッセージがない場合、メソッドは新しいメッセージが到達するまで指定のタイムアウト時間だけ待機します。

public:
 System::Messaging::Message ^ RemoveCurrent(TimeSpan timeout, System::Messaging::MessageQueueTransaction ^ transaction);

public System.Messaging.Message RemoveCurrent (TimeSpan timeout, System.Messaging.MessageQueueTransaction transaction);

member this.RemoveCurrent : TimeSpan * System.Messaging.MessageQueueTransaction -> System.Messaging.Message

Public Function RemoveCurrent (timeout As TimeSpan, transaction As MessageQueueTransaction) As Message

パラメーター

timeout

TimeSpan

削除するメッセージを待機する時間間隔。

transaction

MessageQueueTransaction

メッセージのトランザクション コンテキストを指定する MessageQueueTransaction オブジェクト。

戻り値

Message

キューで利用できる最初のメッセージを参照する Message。

例外

ArgumentException

timeout パラメーターに指定された値が無効です。

ArgumentNullException

transaction パラメーターが null です。

MessageQueueException

タイムアウトの時間が経過しました。

注釈

RemoveCurrent は、カーソルの現在の位置にあるメッセージを削除して返します。 カーソルがキューの末尾にある場合、メソッドのこのオーバーロードは、メッセージが使用可能になるまで待機するか、 timeout パラメーターで指定された間隔の有効期限が切れるまで待機します。

トランザクション キューを操作する場合、トランザクションをロールバックすると、呼び出し RemoveCurrent によって削除されたすべてのメッセージがキューに返されます。 トランザクションがコミットされるまで、削除は元に戻すことができません。

キュージャーナリングを使用している場合、メッセージを削除すると、クラスReceiveのメソッドと同様に、コピーがジャーナル キューにMessageQueue保持されます。

現在のメッセージを削除すると、カーソルは次のメッセージに移動します。 を呼び出した後に を呼び出すMoveNextRemoveCurrent必要はありません。

こちらもご覧ください

• MoveNext()
• Current
• MessageQueueTransaction

RemoveCurrent(TimeSpan, MessageQueueTransactionType)

キューから現在のメッセージを削除し、そのメッセージを呼び出し元アプリケーションに返します。 削除するメッセージがある場合、メソッドはすぐにメッセージを返します。 削除するメッセージがない場合、メソッドは新しいメッセージが到達するまで指定のタイムアウト時間だけ待機します。

public:
 System::Messaging::Message ^ RemoveCurrent(TimeSpan timeout, System::Messaging::MessageQueueTransactionType transactionType);

public System.Messaging.Message RemoveCurrent (TimeSpan timeout, System.Messaging.MessageQueueTransactionType transactionType);

member this.RemoveCurrent : TimeSpan * System.Messaging.MessageQueueTransactionType -> System.Messaging.Message

Public Function RemoveCurrent (timeout As TimeSpan, transactionType As MessageQueueTransactionType) As Message

パラメーター

timeout

TimeSpan

削除するメッセージを待機する時間間隔。

transactionType

MessageQueueTransactionType

メッセージと関連付けるトランザクション コンテキストの種類を示す、MessageQueueTransactionType 値の 1 つ。

戻り値

Message

キューで利用できる最初のメッセージを参照する Message。

例外

ArgumentException

timeout パラメーターに指定された値が無効です。

MessageQueueException

タイムアウトの時間が経過しました。

InvalidEnumArgumentException

transactionType パラメーターが、MessageQueueTransactionType メンバーの 1 つではありません。

注釈

RemoveCurrent パラメーターで定義されたトランザクション コンテキストを使用して、カーソルの現在の場所にあるメッセージを transactionType 削除して返します。 カーソルがキューの末尾にある場合、メソッドのこのオーバーロードは、メッセージが使用可能になるまで待機するか、 timeout パラメーターで指定された間隔の有効期限が切れるまで待機します。

メッセージの受信に使用するtransactionType外部トランザクション コンテキストがスレッドに既にアタッチされている場合は、 パラメーターに を指定Automaticします。 メッセージを 1 つの内部トランザクションとして受信するかどうかを指定 Single します。 トランザクション コンテキスト以外のトランザクション キューからメッセージを受信するかどうかを指定 None できます。

キュージャーナリングを使用している場合、メッセージを削除すると、クラスReceiveのメソッドと同様に、コピーがジャーナル キューにMessageQueue保持されます。

トランザクション キューを操作する場合、トランザクションのロールバックにより、呼び出し RemoveCurrent によって削除されたすべてのメッセージがキューに返されます。 トランザクションがコミットされるまで、削除は元に戻すことができません。

現在のメッセージを削除すると、カーソルは次のメッセージに移動します。 を呼び出した後に を呼び出RemoveCurrentすMoveNext必要はありません。

こちらもご覧ください

• MoveNext()
• Current
• MessageQueueTransactionType