Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved


Chapter 3 Destination : tibemsDestination

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.
 
Related Types
tibemsQueue on page 147
tibemsTemporaryQueue on page 151
tibemsTopic on page 153
tibemsTemporaryTopic on page 152
See Also
tibemsMsg_GetDestination on page 39
tibemsMsg_SetDestination on page 59
tibemsLookupContext on page 314
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
 
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
 
See Also
tibemsDestinationType on page 140
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
 
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
 
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
 
See Also
tibemsDestinationType on page 140

Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved