X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=doc%2Fsrc%2Fman%2Frmr_get_trace.3.xfm;h=6a3ee2c18aff28e90ff90833a046327c995f64a7;hb=HEAD;hp=21c02852ef8f63db52ec9d0f9b69e58839ab7725;hpb=ffba61cdbe908417f2b7a9b6787977531107c55e;p=ric-plt%2Flib%2Frmr.git diff --git a/doc/src/man/rmr_get_trace.3.xfm b/doc/src/man/rmr_get_trace.3.xfm index 21c0285..6a3ee2c 100644 --- a/doc/src/man/rmr_get_trace.3.xfm +++ b/doc/src/man/rmr_get_trace.3.xfm @@ -1,7 +1,7 @@ .if false ================================================================================== - Copyright (c) 2019 Nokia - Copyright (c) 2018-2019 AT&T Intellectual Property. + 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. @@ -18,20 +18,20 @@ .fi .if false - Mnemonic rmr_get_trace.3.xfm - Abstract The manual page for the rmr_get_trace function. - Author E. Scott Daniels - Date 19 April 2019 + Mnemonic rmr_get_trace.3.xfm + Abstract The manual page for the rmr_get_trace function. + Author E. Scott Daniels + Date 19 April 2019 .fi .gv e LIB lib -.im &{lib}/man/setup.im +.im &{lib}/man/setup.im &line_len(6i) &h1(RMR Library Functions) &h2(NAME) - rmr_get_trace + rmr_get_trace &h2(SYNOPSIS) &indent @@ -45,12 +45,12 @@ int rmr_get_trace( rmr_mbuf_t* mbuf, unsigned char* dest, int size ) &h2(DESCRIPTION) The &cw(rmr_get_trace) function will copy the trace information from the message into the user's -allocated memory referenced by &cw(dest.) +allocated memory referenced by &cw(dest.) The &cw(size) parameter is assumed to be the maximum number of bytes which can be copied (size of the destination buffer). &h2(RETURN VALUE) -On success, the number of bytes actually copied is returned. +On success, the number of bytes actually copied is returned. If the return value is 0, no bytes copied, then the reason could be that the message pointer was nil, or the size parameter was <= 0. @@ -86,6 +86,3 @@ rmr_set_trace(3), rmr_trace_ref(3) .ju on - -.qu -