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.
Note: 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.