Copyright © TIBCO Software Inc. All Rights Reserved

> tibemsAdmin_GetConsumer
> Function
> Purpose
> Get consumer with specified ID.
> C Declaration
> tibems_status tibemsAdmin_GetConsumer(
> tibemsAdmin admin,
> tibemsConsumerInfo* consumerInfo,
> tibems_long ID);
> COBOL Call
> CALL "tibemsAdmin_GetConsumer"
> USING BY VALUE admin,
> BY REFERENCE consumerInfo,
> BY VALUE consumerID,
> RETURNING tibems-status
> END-CALL.
> Parameters

> Parameter | Description
> admin | Get a consumer using this administrative connection.
> consumerInfo | The functions stores information about the consumer in this location.
> ID | The consumer ID for which the function will retrieve information.

> Remarks
> Returns the consumer object with specified ID. The returned consumer object contains information about consumer known to server, including details, available statistics. If a consumer with the specified ID does not exist, the function returns NULL.
> Status Codes

> Status Code | Description
> TIBEMS_TIMEOUT | The administrative query timed out while waiting for a server response.
> TIBEMS_NOT_FOUND | No consumer found matching the requested ID.

> See Also
> tibemsConsumerInfo on page 441

Copyright © TIBCO Software Inc. All Rights Reserved