TutOptionSetNum

Name

TutOptionSetNum — set the value of a numeric option

Synopsis

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

Arguments

option — option to set

num_val — numeric value to set option to

Return Values

TRUE if value is set successfully, FALSE otherwise.

Diagnostics

If TutOptionSetNum 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_NUMERIC.

T_ERR_VERIFY_FAILED — verify function failed. Various other error numbers are possible depending on the verify function in use.

Description

TutOptionSetNum sets the numeric value of option to num_val.

Caution

None

Examples

This example sets the value of the option named num_opt to 10.0:

T_OPTION num_opt; 
 
num_opt = TutOptionLookup("num_opt"); 
if (num_opt == NULL) { 
  /* error */ 
} 
 
if (!TutOptionSetNum(num_opt, 10.0)) { 
  /* error */ 
}