tt_feature_required(3)

NAME

tt_feature_required - Declare a feature to be required by the calling code

SYNOPSIS

#include <Tt/tt_c.h>
Tt_status tt_feature_required ( Tt_feature feature );

DESCRIPTION

The tt_feature_required() call declares a feature to be required by the calling code. If the feature requires the ToolTalk service to perform some initialization (e.g. TT_FEATURE_MULTITHREADED), the initialization is performed in this call.

The feature argument is a Tt_feature enum value indicating a particular feature to be used by the calling code.

RETURN VALUE

Upon successful completion, the tt_feature_required() function returns the status of the operation as one of the following Tt_status values:

TT_OK The operation completed successfully.

TT_WRN_NOT_ENABLED
The feature has not yet been enabled.

TT_ERR_UNIMP
The version of the ToolTalk library linked with the calling code does not support the indicated feature.

TT_ERR_TOOLATE
The indicated feature must be declared to be required before calls to the ToolTalk API already made.

APPLICATION USAGE

To use the ToolTalk library in a multithreaded environment, an application would declare multithreading to be required before a call to tt_open or ttdt_open:

Tt_status ttstat;
ttstat = tt_feature_required(TT_FEATURE_MULTITHREADED);
tt_open();

Museum