ListMessages Method

Gets messages from the queue.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int ListMessages(const char* lpszQueueId);

Unicode (Windows)
INT ListMessages(LPCWSTR lpszQueueId);

- (void)listMessages:(NSString*)queueId;

#define MID_AMAZONSQS_LISTMESSAGES 13

IPWORKSMQ_EXTERNAL int IPWORKSMQ_CALL IPWorksMQ_AmazonSQS_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method retrieves messages from the queue specified by QueueId, and fires a Message event for each message it receives. The messages may also be accessed using the property Messages.

If VisibilityTimeout greater than -1 it is applied to the messages, otherwise the default timeout of the queue used. Only one message is retrieved by default; this behavior may be modified by changing MaxMessages.

Note: Unlike messages received from standard queues, messages received from FIFO queues can only be deleted within their VisibilityTimeout. Attempting to call DeleteMessage for a message received from a FIFO queue after its VisibilityTimeout has expired will cause the server to return an error.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)