TutOptionSetStr

Name

TutOptionSetStr — set the value of a string option

Synopsis

T_BOOL TutOptionSetStr(option, str_val) 
T_OPTION option; 
T_STR str_val;

Arguments

option — option to set

str_val — string value to set option to

Return Values

TRUE if value is set successfully, FALSE otherwise.

Diagnostics

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

T_ERR_NULL_PTR — option or str_val was NULL

T_ERR_TYPE_INVALID — option was not of type T_OPT_TYPE_STRING

T_ERR_VERIFY_FAILED — verify function failed. Other error numbers may be possible depending on the verify function for option.

Description

TutOptionSetStr sets the string value of option to str_val.

Caution

None

Examples

This example sets the value of the option named str_opt to "hello world":

T_OPTION str_opt; 
 
str_opt = TutOptionLookup("str_opt"); 
if (str_opt == NULL) { 
  /* error */ 
} 
if (!TutOptionSetStr(str_opt, "hello world")) { 
  /* error */ 
}