RCCE_comm_rank.3 749 B

12345678910111213141516171819202122232425262728293031323334353637
  1. .TH RCCE 3 2010-02-04 "RCCE MANPAGE" "RCCE Library"
  2. .SH NAME
  3. RCCE_comm_rank \- stores the sequence number of the calling UE.
  4. .SH SYNOPSIS
  5. .B #include <rcce.h>
  6. .sp
  7. .BI "int RCCE_comm_size(RCCE_COMM " comm ", int * "rank );
  8. .SH DESCRIPTION
  9. .BR RCCE_comm_rank()
  10. stores the sequence number of the calling UE within communicator comm in the integer rank.
  11. .TP 20
  12. .B comm
  13. The communicator containing the UE whose sequence number the call stores in the integer rank.
  14. .TP
  15. .B rank
  16. The sequence number of the calling UE.
  17. .SH "RETURN VALUE"
  18. Upon successful completion
  19. .BR RCCE_comm_size()
  20. returns
  21. .BR RCCE_SUCCESS .
  22. .SH ERRORS
  23. Look in
  24. .BR rcce.h
  25. for additional error codes.
  26. .SH "SEE ALSO"
  27. rcce.h(5)
  28. .SH EXAMPLE