TutOptionGetKnown

Name

TutOptionGetKnown — retrieves the known state for an option

Synopsis

T_BOOL TutOptionGetKnown(option, known_return) 
T_OPTION option; 
T_BOOL *known_return; 

Arguments

option — option to determine if the value is known

known_return — pointer to storage location to place current known property value

Return Values

TRUE if able to determine known state of option, FALSE otherwise.

Diagnostics

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

Description

TutOptionGetKnown retrieves the current known state of option, such as set to a valid value, and stores it in the location pointed to by known_return.

Caution

None

See Also

TutOptionSetUnknown, TutOptionLookup

Examples

This example determines if the value of the option str_opt is known:

T_OPTION str_opt; 
T_BOOL known; 
 
str_opt = TutOptionLookup("str_opt"); 
if (str_opt == NULL) { 
  /* error */ 
} 
 
if (!TutOptionGetKnown(str_opt, &known)) { 
  /* error */ 
} 
TutOut("str_opt value is %s\n", known ? "KNOWN" : "UNKNOWN");