TutErrStrCreate

Name

TutErrStrCreate — add a new string to the error string table

Synopsis

T_BOOL TutErrStrCreate(err_num, err_str) 
T_INT4 err_num; 
T_STR err_str; 

Arguments

err_num — the new error number

err_str — the descriptive name for the new error number

Return Values

TRUE if the string was successfully added, FALSE otherwise.

Diagnostics

If TutErrStrCreate fails, it returns a FALSE value and the global SmartSockets error number is set to:

Description

This function adds a new error number with a matching descriptive string to the error string table. Subsequent calls to TutErrNumToStr or TutErrStrGet are able to retrieve this error string.

Caution

All error numbers below 100000 are reserved for standard SmartSockets error numbers. TutErrStrCreate does not make a copy of err_str.

See Also

TutErrNumToStr, TutErrStrGet

Examples

This example creates a new error number:

if (!TutErrStrCreate(200000, "disk exploded")) { 
  /* error */ 
}