RCCE_flag_read.3.svn-base 752 B

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. .TH RCCE 3 2010-06-27 "RCCE MANPAGE" "RCCE Library"
  2. .SH NAME
  3. RCCE_flag_read \- reads the flag status of the UE with rank ID (GORY)
  4. .SH SYNOPSIS
  5. .B #include <rcce.h>
  6. .sp
  7. .BI "int RCCE_flag_read(RCCE_FLAG * " flag ",RCCE_FLAG_STATUS ",status ",int " ID );
  8. .SH DESCRIPTION
  9. .BR RCCE_flag_read()
  10. reads the flag status of the UE with rank ID.
  11. .TP
  12. .B
  13. flag
  14. Pointer to a flag in MPB memory.
  15. .TP
  16. .B
  17. status
  18. An enumerated value (RCCE_FLAG_SET or RCCE_FLAG_UNSET) to be read in the flag location of the target UE.
  19. .TP
  20. .B
  21. ID
  22. Rank of the target UE.
  23. .SH "RETURN VALUE"
  24. Upon successful completion
  25. .BR RCCE_flag_read()
  26. returns
  27. .BR RCCE_SUCCESS .
  28. .SH ERRORS
  29. Look in
  30. .BR rcce.h
  31. for additional error codes.
  32. .SH "SEE ALSO"
  33. rcce.h(5)
  34. .SH EXAMPLE
  35. .PP
  36. To be supplied.