TutOptionSetReadOnly

Name

TutOptionSetReadOnly — set whether or not an option is read-only

Synopsis

T_BOOL TutOptionSetReadOnly(option, read_only) 
T_OPTION option; 
T_BOOL read_only; 

Arguments

option — option to set

read_only — sets whether or not the option is read-only

Return Values

TRUE if operation was successful, FALSE otherwise.

Diagnostics

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

Description

TutOptionSetReadOnly sets whether or not option is read-only. A read-only option is an option whose value cannot be changed.

Caution

None

See Also

TutOptionGetReadOnly, TutOptionLookup

Examples

This example makes an option read-only:

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