doc/src/man/rmr_trace_ref.3.xfm

   1 .if false
   2 ==================================================================================
   3         Copyright (c) 2019 Nokia
   4         Copyright (c) 2018-2019 AT&T Intellectual Property.
   5
   6    Licensed under the Apache License, Version 2.0 (the "License");
   7    you may not use this file except in compliance with the License.
   8    You may obtain a copy of the License at
   9
  10        http://www.apache.org/licenses/LICENSE-2.0
  11
  12    Unless required by applicable law or agreed to in writing, software
  13    distributed under the License is distributed on an "AS IS" BASIS,
  14    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15    See the License for the specific language governing permissions and
  16    limitations under the License.
  17 ==================================================================================
  18 .fi
  19
  20 .if false
  21         Mnemonic        rmr_trace_ref.3.xfm
  22         Abstract        The manual page for the rmr_trace_ref function.
  23         Author          E. Scott Daniels
  24         Date            11 July 2019
  25 .fi
  26
  27 .** if formatting with tfm, the roff.im will cause roff output to be generated
  28 .** if formatting with pfm, then pretty postscript will be generated
  29 .gv e LIB lib
  30 .if pfm
  31         .im &{lib}/generic_ps.im
  32 .ei
  33         .gv e OUTPUT_RST use_rst
  34         .if .ev &use_rst 1 =
  35                 .im &{lib}/rst.im
  36         .ei
  37                 .im &{lib}/roff.im
  38         .fi
  39 .fi
  40
  41 &line_len(6i)
  42
  43 &h1(RMR Library Functions)
  44 &h2(NAME)
  45         rmr_trace_ref
  46
  47 &h2(SYNOPSIS)
  48 &indent
  49 &ex_start
  50 #include <rmr/rmr.h>
  51
  52 int rmr_trace_ref( rmr_mbuf_t* mbuf, int* sizeptr )
  53 &ex_end
  54
  55 &uindent
  56
  57 &h2(DESCRIPTION)
  58 The &cw(rmr_trace_ref) function return a pointer to the trace area in the message, and optionally
  59 populate the user programme supplied size integer with the trace area size, if &ital(sizeptr) is
  60 not nil.
  61
  62 &h2(RETURN VALUE)
  63 On success, a void pointer to the trace area of the message is returned.
  64 A nil pointer is returned if the message has no trace data area allocated, or if the message
  65 itself is invalid.
  66
  67
  68 &h2(SEE ALSO )
  69 .ju off
  70 rmr_alloc_msg(3),
  71 rmr_tralloc_msg(3),
  72 rmr_bytes2xact(3),
  73 rmr_bytes2meid(3),
  74 rmr_call(3),
  75 rmr_free_msg(3),
  76 rmr_get_rcvfd(3),
  77 rmr_get_trlen(3),
  78 rmr_init(3),
  79 rmr_init_trace(3),
  80 rmr_payload_size(3),
  81 rmr_send_msg(3),
  82 rmr_rcv_msg(3),
  83 rmr_rcv_specific(3),
  84 rmr_rts_msg(3),
  85 rmr_ready(3),
  86 rmr_fib(3),
  87 rmr_has_str(3),
  88 rmr_tokenise(3),
  89 rmr_mk_ring(3),
  90 rmr_ring_free(3),
  91 rmr_str2meid(3),
  92 rmr_str2xact(3),
  93 rmr_wh_open(3),
  94 rmr_wh_send_msg(3),
  95 rmr_set_trace(3)
  96 .ju on
  97
  98
  99 .qu
 100