tibrvTransport_SetDescription()

Function

Declaration

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

Purpose

Set the program description parameter of a transport.

Remarks

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

As a debugging aid, we recommend setting a unique description string for each transport. Use a string that distinguishes both the application and the role of the transport within it.

Parameter

Description

transport

Set the description parameter of this transport.

It is an error to supply the intra-process transport or virtual circuit transport to this function.

description

Use this string as the new program description.

The function copies this string.

See Also

tibrvTransport

tibrvTransport_GetDescription()