TutOptionLegValAdd

Name

TutOptionLegValAdd — add a legal value to an enumerated option

Synopsis

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

Arguments

option — option to add a legal value to

val — legal value to be added to the option

Return Values

TRUE if the value is added successfully, FALSE otherwise.

Diagnostics

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

T_ERR_NULL_PTR — option or val was NULL

T_ERR_TYPE_INVALID — option was not of type T_OPT_TYPE_ENUM

T_ERR_VAL_INVALID — val was set to unknown, which is not a legal value

T_ERR_ALREADY_EXISTS — val already exists in legal values table for option

Description

TutOptionLegValAdd adds val to the list of legal values allowed for option.

Caution

unknown is reserved and cannot be added as an enumerated value.

Examples

This example adds the legal value red to the enumerated option named colors:

T_OPTION color_opt; 
 
color_opt = TutOptionCreate("colors", T_OPT_TYPE_ENUM); 
if (color_opt == NULL) { 
  /* error */ 
} 
 
if (!TutOptionLegValAdd(color_opt, "red")) { 
  /* error */ 
}