PHP マニュアル
前のページ |  | 次のページ

# SAMConnection::remove()

(no version information, might be only in CVS)

SAMConnection::remove() -- メッセージをキューから削除する

## 説明

class SAMConnection {
SAMMessage remove ( string target [, array properties] )
}

## パラメータ

`target`

  メッセージを削除するキューの識別子。

`properties`

  オプションの連想配列で、削除操作を制御するパラメータを指定します。

  プロパティ名 | とりうる値
  --- | ---
  SAM_CORRELID | メッセージの、対象相関 ID 文字列。 典型的な例は、"send" リクエストが返す相関 ID 文字列となります。
  SAM_MESSAGEID | 削除されるメッセージのメッセージ ID 文字列。

## 返り値

このメソッドは、エラーが発生した場合に `FALSE` を返します。

## 例

例 1. メッセージ ID を指定して、メッセージをキューから削除する

`<?php if (!$conn->remove('queue://receive/test', array(SAM_MESSAGEID => $messageId))) { // 削除に失敗しました! echo "Remove failed ($conn->errno) $conn->error"; } ?>`

前のページ | ホーム | 次のページ
SAMConnection::receive() | 上に戻る | SAMConnection::rollback()