RCCE_debug_set.3 1.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. .TH RCCE 3 2010-03-14 "RCCE MANPAGE" "RCCE Library"
  2. .SH NAME
  3. RCCE_debug_set \- enables runtime debug messages for RCCE library calls.
  4. .SH SYNOPSIS
  5. .B #include <rcce.h>
  6. .sp
  7. .BI "int RCCE_debug_set(int " dbg_enable );
  8. .SH DESCRIPTION
  9. .BR RCCE_debug_set()
  10. enables runtime debug messages for RCCE library calls.
  11. Depending on the value of the input parameter dbg_enable, error messages concerning
  12. synchronization, communication, power management, or all of the above will be printed.
  13. The default is to print all error messages.
  14. .TP
  15. .B dbg_enable
  16. Enables runtime debug messages for RCCE library calls. The parameter dbg_enable can take on the following values.
  17. .BR RCCE_DEBUG_SYNCH
  18. Print error messages concerning synchronization.
  19. .br
  20. .B RCCE_DEBUG_COMM
  21. Print error messages concerning communication.
  22. .br
  23. .BR RCCE_DEBUG_RPC
  24. Print error messages concerning power management.
  25. .SH "RETURN VALUE"
  26. Upon successful completion
  27. .BR RCCE_debug_set ()
  28. returns
  29. .BR RCCE_SUCCESS .
  30. .SH ERRORS
  31. Look in
  32. .BR rcce.h
  33. for additional error codes.
  34. .SH "SEE ALSO"
  35. rcce.h(5)
  36. .SH EXAMPLE