Option Functions (TutOption*)

The TutOption* functions are used to work with options. These functions allow you to create new options, destroy existing options, retrieve the values of options, and set the values of options.

Option Change Callback Functions (TutOptionChangeCb*)

The functions are used to create and look up callback functions which are executed when the value of an option changes.

TutOptionChangeCbCreate — create a callback that is called when the option value changes

T_CB TutOptionChangeCbCreate(option, change_func, arg) 
T_OPTION option; 
T_OPTION_CHANGE_CB_FUNC change_func; 
T_CB_ARG arg;

TutOptionChangeCbLookup — look up the option change callback

T_CB TutOptionChangeCbLookup(option, change_func, arg) 
T_OPTION option; 
T_OPTION_CHANGE_CB_FUNC change_func; 
T_CB_ARG arg;

Creating and Destroying

TutOptionCreate — create a new option

T_OPTION TutOptionCreate(name, type) 
T_STR name; 
T_OPT_TYPE type;

TutOptionDestroy — destroy an existing option

T_BOOL TutOptionDestroy(option) 
T_OPTION option;

Retrieving Values or Properties (TutGet*)

TutOptionGetBool — determine the value of a boolean option

T_BOOL TutOptionGetBool(option, bool_val_return) 
T_OPTION option; 
T_BOOL *bool_val_return;

TutOptionGetEnum — determine the value of an enumerated option

T_BOOL TutOptionGetEnum(option, enum_val_return) 
T_OPTION option; 
T_STR *enum_val_return;

TutOptionGetEnumList — determine the value of an enumerated list option

T_BOOL TutOptionGetEnumList(option, enum_list_val_return) 
T_OPTION option; 
T_STR_LIST *enum_list_val_return;

TutOptionGetKnown — retrieve the known state for an option

T_BOOL TutOptionGetKnown(option, known_flag) 
T_OPTION option; 
T_BOOL *known_flag;

TutOptionGetName — return the name of the option

T_STR TutOptionGetName(option) 
T_OPTION option;

TutOptionGetNum — determine the value of a numeric option

T_BOOL TutOptionGetNum(option, num_val_return) 
T_OPTION option; 
T_REAL8 *num_val_return;

TutOptionGetReadOnly — retrieve read-only property of option

T_BOOL TutOptionGetReadOnly(option, read_only_flag) 
T_OPTION option; 
T_BOOL *read_only_flag;

TutOptionGetRequired — retrieve required property of option

T_BOOL TutOptionGetRequired(option, required_flag) 
T_OPTION option; 
T_BOOL *required_flag;

TutOptionGetStr — determine the value of a string option

T_BOOL TutOptionGetStr(option, str_val_return) 
T_OPTION option; 
T_STR *str_val_return;

TutOptionGetStrList — determine the value of a string list option

T_BOOL TutOptionGetStrList(option, str_list_val_return) 
T_OPTION option; 
T_STR_LIST *str_list_val_return;

TutOptionGetType — return the type of the option

T_BOOL TutOptionGetType(option, opt_type) 
T_OPTION option; 
T_OPT_TYPE *opt_type;

TutOptionGetVerifyFunc — retrieve the verify function

T_BOOL TutOptionGetVerifyFunc(option, verify_func_return) 
T_OPTION option; 
T_OPTION_VERIFY_FUNC *verify_func_return;

Miscellaneous Functions

TutOptionLegValAdd — add a legal value to an enumerated option

T_BOOL TutOptionLegValAdd(option, val) 
T_OPTION option; 
T_STR val;

TutOptionLookup — look up an option by name

T_OPTION TutOptionLookup(name) 
T_STR name;

TutOptionNamedLookup — look up a named option by name

T_OPTION TutOptionNamedLookup(name, option_name) 
T_STR name; 
T_SRV option_name;

Setting the Values or Properties (TutOptionSet*)

TutOptionSetBool — set the value of a boolean option

T_BOOL TutOptionSetBool(option, bool_val) 
T_OPTION option; 
T_BOOL bool_val;

TutOptionSetEnum — set the value of an enumerated option

T_BOOL TutOptionSetEnum(option, enum_val) 
T_OPTION option; 
T_STR enum_val;

TutOptionSetEnumList — set the value of an enumerated list option

T_BOOL TutOptionSetEnumList(option, enum_list_val) 
T_OPTION option; 
T_STR_LIST enum_list_val;

TutOptionSetNum — set the value of a numeric option

T_BOOL TutOptionSetNum(option, num_val) 
T_OPTION option; 
T_REAL8 num_val;

TutOptionSetReadOnly — set whether or not an option is read only

T_BOOL TutOptionSetReadOnly(option, read_only) 
T_OPTION option; 
T_BOOL read_only;

TutOptionSetRequired — set whether or not an option is required

T_BOOL TutOptionSetRequired(option, required) 
T_OPTION option; 
T_BOL required;

TutOptionSetStr — set the value of a string option

T_BOOL TutOptionSetStr(option, str_val) 
T_OPTION option; 
T_STR str_val;

TutOptionSetStrList — set the value of a string list option

T_BOOL TutOptionSetStrList(option, str_list_val) 
T_OPTION option; 
T_STR_LIST str_list_val;

TutOptionSetUnknown — set the value of the option to UNKNOWN

T_BOOL TutOptionSetUnknown(option) 
T_OPTION option;

TutOptionSetVerifyFunc — create a function to verify that the option’s value is acceptable

T_BOOL TutOptionSetVerifyFunc(option, verify_func, arg) 
T_OPTION option; 
T_OPTION_VERIFY_FUNC verify_func; 
T_PTR arg;