.if false
==================================================================================
	Copyright (c) 2019 Nokia 
	Copyright (c) 2018-2019 AT&T Intellectual Property.

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
==================================================================================
.fi

.if false
	Mnemonic	rmr_trace_ref.3.xfm
	Abstract	The manual page for the rmr_trace_ref function.
	Author		E. Scott Daniels
	Date		11 July 2019
.fi

.** if formatting with tfm, the roff.im will cause roff output to be generated
.** if formatting with pfm, then pretty postscript will be generated
.gv e LIB lib
.if pfm
	.im &{lib}/generic_ps.im
.ei
	.gv e OUTPUT_RST use_rst
	.if .ev &use_rst 1 = 
		.im &{lib}/rst.im
	.ei
		.im &{lib}/roff.im
	.fi
.fi

&line_len(6i)

&h1(RMR Library Functions)
&h2(NAME)
	rmr_trace_ref

&h2(SYNOPSIS)
&indent
&ex_start
#include <rmr/rmr.h>

int rmr_trace_ref( rmr_mbuf_t* mbuf, int* sizeptr )
&ex_end

&uindent

&h2(DESCRIPTION)
The &cw(rmr_trace_ref) function return a pointer to the trace area in the message, and optionally
populate the user programme supplied size integer with the trace area size, if &ital(sizeptr) is
not nil.

&h2(RETURN VALUE)
On success, a void pointer to the trace area of the message is returned.  
A nil pointer is returned if the message has no trace data area allocated, or if the message
itself is invalid.


&h2(SEE ALSO )
.ju off
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)
.ju on


.qu