RCCE_get.3 889 B

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. .TH RCCE 3 2010-06-27 "RCCE MANPAGE" "RCCE Library"
  2. .SH NAME
  3. RCCE_get \- copies contents from src to target (GORY)
  4. .SH SYNOPSIS
  5. .B #include <rcce.h>
  6. .sp
  7. .BI "int RCCE_get(volatile char * " target ",volatile char * ",src ",int " num_bytes ",int " ID );
  8. .SH DESCRIPTION
  9. .BR RCCE_get()
  10. copies the contents of the buffer pointed to by src into the location pointed to by target.
  11. .TP
  12. .B
  13. target
  14. Address in calling UE.s local MPB or the private memory of the calling UE that \
  15. points to the data to be gotten.
  16. .TP
  17. .B
  18. src
  19. An offset that, when combined with the ID, points to the source MPB.
  20. .TP
  21. .B
  22. num_bytes
  23. Number of bytes to copy to the target.
  24. .TP
  25. .B
  26. ID
  27. Rank of the target UE.
  28. .SH "RETURN VALUE"
  29. Upon successful completion
  30. .BR RCCE_get()
  31. returns
  32. .BR RCCE_SUCCESS .
  33. .SH ERRORS
  34. Look in
  35. .BR rcce.h
  36. for additional error codes.
  37. .SH "SEE ALSO"
  38. rcce.h(5)
  39. .SH EXAMPLE
  40. .PP
  41. To be supplied.