RCCE_put.3 930 B

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. .TH RCCE 3 2010-06-27 "RCCE MANPAGE" "RCCE Library"
  2. .SH NAME
  3. RCCE_put \- copies contents from src to target (GORY)
  4. .SH SYNOPSIS
  5. .B #include <rcce.h>
  6. .sp
  7. .BI "int RCCE_put(volatile char * " target ",volatile char * ",src ",int " num_bytes ",int " ID );
  8. .SH DESCRIPTION
  9. .BR RCCE_put()
  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. An MPB address that will be converted to the appropriate address on UE with rank
  15. ID that points to where the data will go.
  16. .TP
  17. .B
  18. src
  19. The address in private memory or the local MPB of the calling UE
  20. that points to the data to be put.
  21. .TP
  22. .B
  23. num_bytes
  24. Number of bytes to copy to the target.
  25. .TP
  26. .B
  27. ID
  28. Rank of the target UE.
  29. .SH "RETURN VALUE"
  30. Upon successful completion
  31. .BR RCCE_put()
  32. returns
  33. .BR RCCE_SUCCESS .
  34. .SH ERRORS
  35. Look in
  36. .BR rcce.h
  37. for additional error codes.
  38. .SH "SEE ALSO"
  39. rcce.h(5)
  40. .SH EXAMPLE
  41. .PP
  42. To be supplied.