Copyright © TIBCO Software Inc. All Rights Reserved

> tibemsDestination
> Type
> Purpose
> Represent a named queue or topic in the server.
> Remarks
> Administrators define destinations in the server. Client programs access them using functions of tibemsLookupContext.

> Function | Description | Page
> tibemsDestination_Copy | Create an independent copy of a destination object. | 145
> tibemsDestination_Create | Create a destination object. | 146
> tibemsDestination_Destroy | Destroy a destination object. | 147
> tibemsDestination_GetName | Get the name of a destination object. | 148
> tibemsDestination_GetType | Get the type of a destination object. | 149

> Related Types
> tibemsQueue on page 150
> tibemsTemporaryQueue on page 154
> tibemsTopic on page 156
> tibemsTemporaryTopic on page 155
> See Also
> tibemsMsg_GetDestination on page 40
> tibemsMsg_SetDestination on page 61
> tibemsLookupContext on page 322
> tibemsDestination_Copy
> Function
> Purpose
> Create an independent copy of a destination object.
> C Declaration
> tibems_status tibemsDestination_Copy(
> tibemsDestination destination,
> tibemsDestination* copy );
> COBOL Call
> CALL "tibemsDestination_Copy"
> USING BY VALUE destination,
> BY REFERENCE copy,
> RETURNING tibems-status
> END-CALL.

> | destination has usage pointer.

> Parameters

> Parameter | Description
> destination | Copy this existing destination object.
> copy | The function stores the new copy in this location.

> tibemsDestination_Create
> Function
> Purpose
> Create a destination object.
> C Declaration
> tibems_status tibemsDestination_Create(
> tibemsDestination* destination,
> tibemsDestinationType type,
> const char* name );
> COBOL Call
> CALL "tibemsDestination_Create"
> USING BY REFERENCE destination,
> BY VALUE type,
> BY REFERENCE name,
> RETURNING tibems-status
> END-CALL.

> | destination has usage pointer.

> Parameters

> Parameter | Description
> destination | The function stores the new destination in this location.
> type | Create a destination of this type (queue or topic).
> name | Create a destination with this name.

> See Also
> tibemsDestinationType on page 143
> tibemsDestination_Destroy
> Function
> Purpose
> Destroy a destination object.
> C Declaration
> tibems_status tibemsDestination_Destroy(
> tibemsDestination destination );
> COBOL Call
> CALL "tibemsDestination_Destroy"
> USING BY VALUE destination,
> RETURNING tibems-status
> END-CALL.

> | destination has usage pointer.

> Parameters

> Parameter | Description
> destination | Destroy this destination.

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

> | destination has usage pointer.

> Parameters

> Parameter | Description
> destination | Get the name of this destination.
> 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 name is greater than the size of the buffer provided, the entire destination 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.
> tibemsDestination_GetType
> Function
> Purpose
> Get the type of a destination object.
> C Declaration
> tibems_status tibemsDestination_GetType(
> tibemsDestination destination,
> tibemsDestinationType* type );
> COBOL Call
> CALL "tibemsDestination_GetType"
> USING BY VALUE destination,
> BY REFERENCE type,
> RETURNING tibems-status
> END-CALL.

> | destination has usage pointer.

> Parameters

> Parameter | Description
> destination | Get the type of this destination.
> type | The function stores the type in this location.

> See Also
> tibemsDestinationType on page 143

Copyright © TIBCO Software Inc. All Rights Reserved