ClearMessages Method

Clears all messages from the queue.

Syntax

queue.clearMessages([callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method deletes all messages from the queue specified by QueueName.

Note that if a queue contains a large number of messages, the operation on the Azure server may time out before all messages have been deleted. In this case the Queue service will return status code 500 (Internal Server Error).

If the operation times out, call this method again until it succeeds to ensure that all messages have been deleted.