SAMConnection::remove()

(no version information, might be only in CVS)

SAMConnection::remove() --  Remove a message from a queue.

Description

class SAMConnection {

SAMMessage remove ( string target [, array properties] )

}

Warning: This method is not currently implemented.

Parameters

target

The identity of the queue from which to remove the message.

properties

An optional associative array of properties describing other parameters to control the remove operation.

Property namePossible values
SAM_SELECTString selector used to select messages from the queue. Typically this the correlation id string returned by a "send" request.

Return Values

This method returns FALSE if an error occurs.

Examples

Example 1. Removing a message from a queue with options

<?php
if (!$conn->remove('queue://receive/test', array(SAM_SELECT => $token))) {
  
// The remove failed!
  
echo "Remove failed ($conn->errno) $conn->error";
}
?>