tibemsAdmin_GetProducerStatistics

Function

Purpose

Return statistical information about producers that match the specified parameters.

C Declaration

tibems_status tibemsAdmin_GetProducerStatistics(
    tibemsAdmin admin,
    tibemsCollection* collection,
    tibems_long connectionID,
    const char*  username,
    tibemsDestinationInfo destination);

COBOL Call

CALL "tibemsAdmin_GetProducerStatistics"
 USING BY VALUE admin,
       BY REFERENCE prodInfos,
       BY REFERENCE username,
       BY VALUE connectionID,
       BY VALUE destination,
       RETURNING tibems-status
END-CALL.
Note: prodInfos has usage pointer.

Parameters

Parameter Description
admin Get the producer statistics using this administrative connection.
collection Store the returned producer data in the location specified here, as a collection of tibemsProducerInfo objects.
connectionID Must be set to zero. This parameter is reserved for future use.
username If specified, only producers for connections that use the specified user name will be returned. Specify NULL if all producers should be returned.
destination If specified, only producers on destinations of the same type and matching this destination name will be returned. destination can be:

The destination name may include wildcards.

Remarks

Return information about message producers, including the statistical information about producers with specified parameters.

Status Codes

Status Code Description
TIBEMS_TIMEOUT The administrative query timed out while waiting for a server response.
TIBEMS_NOT_FOUND No producers found matching the specified parameters.

See Also

tibemsStatData

tibemsDetailedDestStat