X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=doc%2Fsrc%2Fman%2Frmr_get_xact.3.xfm;h=6506614b532461ac142039f45e79b6bdd29ceb3e;hb=b7a4b52f73d51db6077d2c0b56be262c36f472f7;hp=8674702a4ff725f52339603568170457e28ae96d;hpb=392168d467d7949f391602f53f9fd62d2a64d12b;p=ric-plt%2Flib%2Frmr.git diff --git a/doc/src/man/rmr_get_xact.3.xfm b/doc/src/man/rmr_get_xact.3.xfm index 8674702..6506614 100644 --- a/doc/src/man/rmr_get_xact.3.xfm +++ b/doc/src/man/rmr_get_xact.3.xfm @@ -46,18 +46,18 @@ char* rmr_get_xact( rmr_mbuf_t* mbuf, unsigned char* dest ) &h2(DESCRIPTION) The &cw(rmr_get_xact) function will copy the transaction field from the message into the &ital(dest) buffer provided by the user. -The buffer referenced by &ital( dest ) is assumed to be at least &cw(RMR_MAX_XID) bytes in length. -If &ital( dest ) is NULL, then a buffer is allocated (the calling application is expected +The buffer referenced by &ital(dest) is assumed to be at least &cw(RMR_MAX_XID) bytes in length. +If &ital(dest) is NULL, then a buffer is allocated (the calling application is expected to free when the buffer is no longer needed). &h2(RETURN VALUE) On success, a pointer to the extracted string is returned. -If &ital( dest ) was supplied, then this is just a pointer to the caller's buffer. -If &ital( dest ) was NULL, this is a pointer to the allocated buffer. +If &ital(dest) was supplied, then this is just a pointer to the caller's buffer. +If &ital(dest) was NULL, this is a pointer to the allocated buffer. If an error occurs, a nil pointer is returned and errno is set as described below. &h2(ERRORS) -If an error occurs, the value of the global variable &cw( errno ) will be set to one of +If an error occurs, the value of the global variable &cw(errno) will be set to one of the following with the indicated meaning. &beg_dlist(.75i : ^&bold_font ) @@ -65,7 +65,7 @@ the following with the indicated meaning. &di(EINVAL) The message, or an internal portion of the message, was corrupted or the pointer was invalid. &half_space -&di(ENOMEM) A nil pointer was passed for &ital( dest, ) however it was not possible to allocate a +&di(ENOMEM) A nil pointer was passed for &ital(dest,) however it was not possible to allocate a buffer using malloc(). &end_dlist