RCCE_wait_until.3 856 B

12345678910111213141516171819202122232425262728293031323334353637383940
  1. .TH RCCE 3 2010-06-27 "RCCE MANPAGE" "RCCE Library"
  2. .SH NAME
  3. RCCE_wait_until \- blocks until the status of flag matches the input parameter (GORY)
  4. .SH SYNOPSIS
  5. .B #include <rcce.h>
  6. .sp
  7. .BI "int RCCE_wait_until(RCCE_FLAG * " flag ",RCCE_FLAG_STATUS ",status );
  8. .SH DESCRIPTION
  9. .BR RCCE_flag_wait_until()
  10. blocks until the status of flag matches the input parameter.
  11. .TP
  12. .B
  13. flag
  14. Opaque data type representing a flag in MPB memory.
  15. .TP
  16. .B
  17. status
  18. Status value that must be matched by the status field of the synchronization flag.
  19. Possible values are RCCE_FLAG_SET and RCCE_FLAG_UNSET. All flags have
  20. status RCCE_FLAG_UNSET at program start.
  21. .SH "RETURN VALUE"
  22. Upon successful completion
  23. .BR RCCE_flag_write()
  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
  33. .PP
  34. To be supplied.