tibrvTransport_GetDescription()

Function

Declaration

tibrv_status tibrvTransport_GetDescription(
    tibrvTransport    transport,
    const char**      description);

Purpose

Extract the program description parameter from a transport.

Remarks

The description identifies your program to Rendezvous components. Browser administration interfaces display the description string.

This function returns the description parameter as a NULL-terminated string.

Parameter	Description
transport	Extract the description parameter from this transport. It is an error to supply the intra-process transport or virtual circuit transport to this function.
description	The program supplies a location, and the function places in that location a string pointer to the description. The program must not modify nor free the string.

See Also

tibrvTransport

tibrvTransport_SetDescription()