X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Frmr_get_trlen.3.rst;h=c438157c36aa295a4e7d0a5ab1928fb83dc9f800;hb=a3a121ca4a0426ec964fa684fb27c397f2ee9e24;hp=86490b0875654f312b7f0f097d7f66d13f0fd82f;hpb=2b3c393e660c5e1037191f43cc70537da8316b89;p=ric-plt%2Flib%2Frmr.git diff --git a/docs/rmr_get_trlen.3.rst b/docs/rmr_get_trlen.3.rst index 86490b0..c438157 100644 --- a/docs/rmr_get_trlen.3.rst +++ b/docs/rmr_get_trlen.3.rst @@ -1,62 +1,73 @@ - - .. 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_trlen ============================================================================================ -RMR Library Functions -============================================================================================ - - -NAME --------------------------------------------------------------------------------------------- + + +RMR LIBRARY FUNCTIONS +===================== + + + +NAME +---- + rmr_get_trlen - -SYNOPSIS --------------------------------------------------------------------------------------------- - + + +SYNOPSIS +-------- + :: - + #include + int rmr_get_trlen( rmr_mbuf_t* msg ); - - -DESCRIPTION --------------------------------------------------------------------------------------------- - + + +DESCRIPTION +----------- + Given a message buffer, this function returns the amount of space (bytes) that have been allocated for trace data. If no trace data has been allocated, then 0 is returned. - -RETURN VALUE --------------------------------------------------------------------------------------------- - + + +RETURN VALUE +------------ + The number of bytes allocated for trace information in the given message. - -ERRORS --------------------------------------------------------------------------------------------- - - - -INVAL - - Parameter(s) passed to the function were not valid. - - -SEE ALSO --------------------------------------------------------------------------------------------- - + + +ERRORS +------ + + + .. list-table:: + :widths: auto + :header-rows: 0 + :class: borderless + + * - **INVAL** + - + Parameter(s) passed to the function were not valid. + + + + +SEE ALSO +-------- + rmr_alloc_msg(3), rmr_call(3), rmr_free_msg(3), rmr_get_trace(3), rmr_init(3), rmr_init_trace(3), rmr_send_msg(3), rmr_rcv_msg(3), rmr_rcv_specific(3),