TutOptionGetNum

Name

TutOptionGetNum — get the value of a numeric option

Synopsis

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

Arguments

option — option to get numeric value of

num_val_return — pointer to T_REAL8 field into which TutOptionGetNum copies the numeric value

Return Values

TRUE if value is retrieved successfully, FALSE otherwise.

Diagnostics

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

T_ERR_NULL_PTR — option or num_val_return was NULL

T_ERR_TYPE_INVALID — option was not of type T_OPT_TYPE_NUMERIC

T_ERR_VAL_UNKNOWN — value of option is UNKNOWN

Description

TutOptionGetNum gets the numeric value of option. The value is copied into storage pointed to by num_val_return, which must be managed by the caller.

Caution

None

Examples

This example gets the value of the option named num_opt:

T_OPTION num_opt; 
T_REAL8 num_val; 
num_opt = TutOptionLookup("num_opt"); 
if (num_opt == NULL) { 
  /* error */ 
} 
if (!TutOptionGetNum(num_opt, &num_val)) { 
  /* error */ 
}