TutOptionDestroy

Name

TutOptionDestroy — destroy an existing option

Synopsis

T_BOOL TutOptionDestroy(option) 
T_OPTION option; 

Arguments

option — option to destroy

Return Values

TRUE if the option was successfully destroyed, FALSE otherwise.

Diagnostics

If TutOptionDestroy fails, it returns FALSE and sets the global SmartSockets error number to:

Description

TutOptionDestroy destroys option. All storage allocated for option is deallocated.

Caution

In general, it is unsafe to destroy standard options that are provided in SmartSockets processes. These processes frequently fail in unexpected ways if any of the standard options have been destroyed.

See Also

TutOptionCreate, TutOptionLookup

Examples

This example destroys the option named bool_opt:

T_OPTION option; 
T_BOOL status; 
 
/* Look up the option first */ 
option =     TutOptionLookup("bool_opt"); 
if (option == NULL) { 
  /* error */ 
} 
if (!TutOptionDestroy(option)) { 
  /* error */ 
}