2 ==================================================================================
3 Copyright (c) 2019 Nokia
4 Copyright (c) 2018-2019 AT&T Intellectual Property.
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
10 http://www.apache.org/licenses/LICENSE-2.0
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 ==================================================================================
21 Mnemonic rmr_get_trace.3.xfm
22 Abstract The manual page for the rmr_get_trace function.
23 Author E. Scott Daniels
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
31 .im &{lib}/generic_ps.im
33 .gv e OUTPUT_RST use_rst
43 &h1(RMR Library Functions)
52 int rmr_get_trace( rmr_mbuf_t* mbuf, unsigned char* dest, int size )
58 The &cw(rmr_get_trace) function will copy the trace information from the message into the user's
59 allocated memory referenced by &cw(dest.)
60 The &cw(size) parameter is assumed to be the maximum number of bytes which can be copied (size
61 of the destination buffer).
64 On success, the number of bytes actually copied is returned.
65 If the return value is 0, no bytes copied, then the reason could be that the message pointer
66 was nil, or the size parameter was <= 0.