TutOptionCreate

Name

TutOptionCreate — create a new option

Synopsis

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

Arguments

name — option name (not case sensitive)

type — option value type

Return Values

Returns pointer to new option, NULL if option already exists.

Diagnostics

If TutOptionCreate fails, it returns NULL and sets the global SmartSockets error number to one of:

T_ERR_NULL_PTR — name argument was NULL

T_ERR_VAL_INVALID — type argument was not valid

T_ERR_ALREADY_EXISTS — option has already been created

Description

TutOptionCreate creates a new SmartSockets option. An option consists of name and type, where name is a string that is not case sensitive, and type is one of:

T_OPT_TYPE_BOOLEAN

T_OPT_TYPE_ENUM

T_OPT_TYPE_NUMERIC

T_OPT_TYPE_STRING

T_OPT_TYPE_LIST_ENUM

T_OPT_TYPE_LIST_NUMERIC

T_OPT_TYPE_LIST_STRING

SmartSockets options are similar to environment variables used by operating systems, plus they have additional built-in type-checking capabilities. Option change callbacks can be used to notify you when the option’s value changes. See TutOptionChangeCbCreate on page 151 for more information on option change callbacks.

Caution

The name argument must be an identifier.

Examples

This example creates a boolean option named bool_opt:

T_OPTION option; 
 
option = TutOptionCreate("bool_opt", T_OPT_TYPE_BOOLEAN); 
 
if (option == NULL) { 
  /* error */ 
}