TutOptionSetUnknown

Name

TutOptionSetUnknown — set the value of the option to UNKNOWN

Synopsis

T_BOOL TutOptionSetUnknown(option) 
T_OPTION option; 

Arguments

option — option to be set to UNKNOWN

Return Values

TRUE if operation is successful, FALSE otherwise.

Diagnostics

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

Description

TutOptionSetUnknown sets the current value of option to UNKNOWN. This is similar to using the unsetopt command from the command interface.

Caution

None

See Also

TutOptionGetKnown, TutOptionLookup

Examples

This example sets the value of the option named str_opt to UNKNOWN:

T_OPTION str_opt; 
 
str_opt = TutOptionLookup("str_opt"); 
if (str_opt == NULL) { 
  /* error */ 
} 
 
if (!TutOptionSetUnknown(str_opt)) { 
  /* error */ 
}