TutOptionSetBool

Name

TutOptionSetBool — set the value of a boolean option

Synopsis

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

Arguments

option — option to set

bool_val — boolean value to set option to

Return Values

TRUE if value is set successfully, FALSE otherwise.

Diagnostics

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

T_ERR_NULL_PTR — option was NULL.

T_ERR_TYPE_INVALID — option was not of type T_OPT_TYPE_BOOL.

T_ERR_VAL_INVALID — bool_val not a boolean value (TRUE or FALSE).

T_ERR_VERIFY_FUNC — verify function failed. Other error numbers are possible depending on the verify function for option.

Description

TutOptionSetBool sets the boolean value of option to bool_val.

Caution

None

Examples

This example sets the value of the option named bool_opt to TRUE:

T_OPTION bool_opt; 
 
bool_opt = TutOptionLookup("bool_opt"); 
if (bool_opt == NULL) { 
  /* error */ 
} 
if (!TutOptionSetBool(bool_opt, TRUE)) { 
  /* error */ 
}