TutOptionSetRequired

Name

TutOptionSetRequired — set whether or not an option is required

Synopsis

T_BOOL TutOptionSetRequired(option, required) 
T_OPTION option; 
T_BOOL required; 

Arguments

option — option to set

required — sets whether or not the option is required

Return Values

TRUE if operation was successful, FALSE otherwise.

Diagnostics

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

Description

TutOptionSetRequired sets whether or not option is required. A required option is an option that cannot be unset.

Caution

None

See Also

TutOptionGetRequired, TutOptionLookup

Examples

This example makes an option required:

T_OPTION opt; 
 
opt = TutOptionLookup("any_option"); 
if (opt == NULL) { 
  /* error */ 
} 
 
if (!TutOptionSetRequired(opt, TRUE)) { 
  /* error */ 
}