MessagesDequeueCount Property

When ListMessages is called, the message is dequeued and this value is incremented.

Syntax

 queue.getMessagesDequeueCount(index, [callback])

Default Value

0

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 the getMessagesDequeueCount([callback]) method is defined as:

function(err, data){ }

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

'data' is the value returned by the method.

The callback for the setMessagesDequeueCount([callback]) 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

When ListMessages is called, the message is dequeued and this value is incremented. This servers as a counter of how many times a message has been dequeued. This value is not incremented when PeekMessages is called.

The size of the array is controlled by the MessagesCount property.

This property is read-only and not available at design time.

Data Type

Integer