Copyright © TIBCO Software Inc. All Rights Reserved

> tibemsQueue
> Type
> Purpose
> Queues deliver each message to exactly one consumer.

> Function | Description | Page
> tibemsQueue_Create | Create a queue object. | 151
> tibemsQueue_Destroy | Destroy a queue object. | 152
> tibemsQueue_GetQueueName | Get the name of a queue object. | 153

> Related Types
> tibemsDestination on page 144
> tibemsTemporaryQueue on page 154
> tibemsQueue_Create
> Function
> Purpose
> Create a queue object.
> C Declaration
> tibems_status tibemsQueue_Create(
> tibemsQueue* queue,
> const char* queueName );
> COBOL Call
> CALL "tibemsQueue_Create"
> USING BY REFERENCE queue,
> BY REFERENCE queueName,
> RETURNING tibems-status
> END-CALL.

> | queue has usage pointer.

> Parameters

> Parameter | Description
> queue | The function stores the queue object in this location.
> queueName | Create a local queue instance with this name.

> Remarks
> This call creates only local objects (within the program). It does not attempt to bind the local queue object to the corresponding server object until the program creates a tibemsMsgConsumer or a tibemsMsgProducer that uses the queue.
> The bind can fail for the following reasons:

> • | Authorization is enabled for the queue and the user does not have the appropriate permissions.

> • | The queue does not exist and the server cannot dynamically create the queue.

> See Also
> tibemsLookupContext on page 322
> tibemsQueue_Destroy
> Function
> Purpose
> Destroy a queue object.
> C Declaration
> tibems_status tibemsQueue_Destroy(
> tibemsQueue queue );
> COBOL Call
> CALL "tibemsQueue_Destroy"
> USING BY VALUE queue,
> RETURNING tibems-status
> END-CALL.

> | queue has usage pointer.

> Parameters

> Parameter | Description
> queue | Destroy this queue.

> tibemsQueue_GetQueueName
> Function
> Purpose
> Get the name of a queue object.
> C Declaration
> tibems_status tibemsQueue_GetQueueName(
> tibemsQueue queue,
> char* name,
> tibems_int name_len );
> COBOL Call
> CALL "tibemsQueue_GetQueueName"
> USING BY VALUE queue,
> BY REFERENCE name,
> BY VALUE name-len
> RETURNING tibems-status
> END-CALL.

> | queue has usage pointer.

> Parameters

> Parameter | Description
> queue | Get the name of this queue.
> name | The function copies the name to this location.
> name_len | Length of the name buffer.

> Remarks
> A null character terminates the copied name string.
> Your program must allocate the name buffer, and pass its length to the function. If the length of the queue name is greater than the size of the buffer provided, the entire queue name may not be copied. The buffer size is determined by the TIBEMS_DESTINATION_MAX constant. Constants such as TIBEMS_DESTINATION_MAX are located in the tibems/types.h header file.

Copyright © TIBCO Software Inc. All Rights Reserved