RCCE_error_string.3 709 B

12345678910111213141516171819202122232425262728293031323334353637383940
  1. .TH RCCE 3 2010-02-04 "RCCE MANPAGE" "RCCE Library"
  2. .SH NAME
  3. RCCE_error_string \- Sets an error string.
  4. .SH SYNOPSIS
  5. .B #include <rcce.h>
  6. .sp
  7. .BI "int RCCE_error_string(int " err_no ", char * " error_string ", int * " string_length );
  8. .SH DESCRIPTION
  9. For a given numerical code,
  10. .BR RCCE_error_string()
  11. sets a descriptive string and sets the length of that string.
  12. .TP 20
  13. .B err_no
  14. Given numerical code.
  15. .TP
  16. .B error_string
  17. Descriptive error string.
  18. .TP
  19. .B string_length
  20. Length of th descriptive string.
  21. .SH "RETURN VALUE"
  22. Upon successful completion
  23. .BR RCCE_error_string()
  24. returns
  25. .BR RCCE_SUCCESS .
  26. .SH ERRORS
  27. Look in
  28. .BR rcce.h
  29. for additional error codes.
  30. .SH "SEE ALSO"
  31. rcce.h(5)
  32. .SH EXAMPLE