tibemsAdmin_GetQueue

Function

Purpose

Get information about a queue of the given queue name.

C Declaration

tibems_status tibemsAdmin_GetQueue(
    tibemsAdmin admin,
    tibemsQueueInfo* queueInfo,
    const char* queueName);

COBOL Call

CALL "tibemsAdmin_GetQueue"
 USING BY VALUE admin,
       BY REFERENCE queueInfo,
       BY REFERENCE name,
       RETURNING tibems-status
END-CALL.

Parameters

Parameter Description
admin Get information about a queue using this administrative connection.
queueInfo Store information about the specified queue in this location.
queueName Name of the queue for which information will be retrieved.

Remarks

Get a tibemsQueueInfo object for the specified queue name. If the queueName does not exist, the function returns TIBEMS_NOT_FOUND.

Status Codes

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

See Also

tibemsQueueInfo