docs/rmr_get_trlen.3.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. CAUTION: this document is generated from source in doc/src/rtd.
   4 .. To make changes edit the source and recompile the document.
   5 .. Do NOT make changes directly to .rst or .md files.
   6
   7 ============================================================================================
   8 Man Page: rmr_get_trlen
   9 ============================================================================================
  10
  11
  12
  13
  14 RMR LIBRARY FUNCTIONS
  15 =====================
  16
  17
  18
  19 NAME
  20 ----
  21
  22 rmr_get_trlen
  23
  24
  25 SYNOPSIS
  26 --------
  27
  28
  29 ::
  30
  31   #include <rmr/rmr.h>
  32
  33   int rmr_get_trlen( rmr_mbuf_t* msg );
  34
  35
  36
  37 DESCRIPTION
  38 -----------
  39
  40 Given a message buffer, this function returns the amount of
  41 space (bytes) that have been allocated for trace data. If no
  42 trace data has been allocated, then 0 is returned.
  43
  44
  45 RETURN VALUE
  46 ------------
  47
  48 The number of bytes allocated for trace information in the
  49 given message.
  50
  51
  52 ERRORS
  53 ------
  54
  55
  56     .. list-table::
  57       :widths: auto
  58       :header-rows: 0
  59       :class: borderless
  60
  61       * - **INVAL**
  62         -
  63           Parameter(s) passed to the function were not valid.
  64
  65
  66
  67
  68 SEE ALSO
  69 --------
  70
  71 rmr_alloc_msg(3), rmr_call(3), rmr_free_msg(3),
  72 rmr_get_trace(3), rmr_init(3), rmr_init_trace(3),
  73 rmr_send_msg(3), rmr_rcv_msg(3), rmr_rcv_specific(3),
  74 rmr_rts_msg(3), rmr_ready(3), rmr_fib(3), rmr_has_str(3),
  75 rmr_tokenise(3), rmr_mk_ring(3), rmr_ring_free(3),
  76 rmr_set_trace(3), rmr_tralloc_msg(3)