X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Frmr_get_trace.3.rst;h=0f1fc8b933bb963c766b3ab6703c0a90a43ba191;hb=fcea3951d44de0cc55d33c5e114487abe79d3406;hp=2c27b8d09b7d13a7dfe985e3297acef623201f31;hpb=a3a121ca4a0426ec964fa684fb27c397f2ee9e24;p=ric-plt%2Flib%2Frmr.git diff --git a/docs/rmr_get_trace.3.rst b/docs/rmr_get_trace.3.rst index 2c27b8d..0f1fc8b 100644 --- a/docs/rmr_get_trace.3.rst +++ b/docs/rmr_get_trace.3.rst @@ -1,14 +1,14 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. SPDX-License-Identifier: CC-BY-4.0 -.. CAUTION: this document is generated from source in doc/src/rtd. -.. To make changes edit the source and recompile the document. -.. Do NOT make changes directly to .rst or .md files. - -============================================================================================ -Man Page: rmr_get_trace -============================================================================================ - - +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. CAUTION: this document is generated from source in doc/src/rtd. +.. To make changes edit the source and recompile the document. +.. Do NOT make changes directly to .rst or .md files. + +============================================================================================ +Man Page: rmr_get_trace +============================================================================================ + + RMR LIBRARY FUNCTIONS @@ -19,49 +19,49 @@ RMR LIBRARY FUNCTIONS NAME ---- -rmr_get_trace +rmr_get_trace SYNOPSIS -------- - -:: - - #include - - int rmr_get_trace( rmr_mbuf_t* mbuf, unsigned char* dest, int size ) - + +:: + + #include + + int rmr_get_trace( rmr_mbuf_t* mbuf, unsigned char* dest, int size ) + DESCRIPTION ----------- -The ``rmr_get_trace`` function will copy the trace -information from the message into the user's allocated memory -referenced by ``dest.`` The ``size`` parameter is assumed to -be the maximum number of bytes which can be copied (size of -the destination buffer). +The ``rmr_get_trace`` function will copy the trace +information from the message into the user's allocated memory +referenced by ``dest.`` The ``size`` parameter is assumed to +be the maximum number of bytes which can be copied (size of +the destination buffer). RETURN VALUE ------------ -On success, the number of bytes actually copied is returned. -If the return value is 0, no bytes copied, then the reason -could be that the message pointer was nil, or the size -parameter was <= 0. +On success, the number of bytes actually copied is returned. +If the return value is 0, no bytes copied, then the reason +could be that the message pointer was nil, or the size +parameter was <= 0. SEE ALSO -------- -rmr_alloc_msg(3), rmr_tralloc_msg(3), rmr_bytes2xact(3), -rmr_bytes2meid(3), rmr_call(3), rmr_free_msg(3), -rmr_get_rcvfd(3), rmr_get_trlen(3), rmr_init(3), -rmr_init_trace(3), rmr_payload_size(3), rmr_send_msg(3), -rmr_rcv_msg(3), rmr_rcv_specific(3), rmr_rts_msg(3), -rmr_ready(3), rmr_fib(3), rmr_has_str(3), rmr_tokenise(3), -rmr_mk_ring(3), rmr_ring_free(3), rmr_str2meid(3), -rmr_str2xact(3), rmr_wh_open(3), rmr_wh_send_msg(3), -rmr_set_trace(3), rmr_trace_ref(3) +rmr_alloc_msg(3), rmr_tralloc_msg(3), rmr_bytes2xact(3), +rmr_bytes2meid(3), rmr_call(3), rmr_free_msg(3), +rmr_get_rcvfd(3), rmr_get_trlen(3), rmr_init(3), +rmr_init_trace(3), rmr_payload_size(3), rmr_send_msg(3), +rmr_rcv_msg(3), rmr_rcv_specific(3), rmr_rts_msg(3), +rmr_ready(3), rmr_fib(3), rmr_has_str(3), rmr_tokenise(3), +rmr_mk_ring(3), rmr_ring_free(3), rmr_str2meid(3), +rmr_str2xact(3), rmr_wh_open(3), rmr_wh_send_msg(3), +rmr_set_trace(3), rmr_trace_ref(3)