tibemsConsumerInfo_GetPendingMessageCount

Function

Purpose

Get the number of pending messages for a topic consumer.

C Declaration

tibems_status tibemsConsumerInfo_GetPendingMessageCount(
    tibemsConsumerInfo consumerInfo,
    tibems_long* count);

COBOL Call

CALL "tibemsConsumerInfo_GetPendingMessageCount"
 USING BY VALUE consumerInfo,
       BY REFERENCE count,
       RETURNING tibems-status
END-CALL.

Parameters

Parameter Description
consumerInfo Get the number of pending messages for this consumer.
count Store the number of pending messages.

Remarks

This function can be used to retrieve the number of pending messages for a topic consumer only. For queue consumers, the number of pending messages in the corresponding queue must be obtained from the queue. If the consumer is a queue consumer, the function returns 0 (zero).