X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=doc%2Fsrc%2Fman%2Frmr_get_meid.3.xfm;h=39fcafda6e4a56e3252659ed4faa8c066ecf1ba0;hb=4d1f9bf4b14788f957964d93af940e84f8f01601;hp=939a3722ef85ff7fd7a9cf6caf7edab61e6174d8;hpb=3ca996aaf32fe37d727b29d6fb88354365988561;p=ric-plt%2Flib%2Frmr.git diff --git a/doc/src/man/rmr_get_meid.3.xfm b/doc/src/man/rmr_get_meid.3.xfm index 939a372..39fcafd 100644 --- a/doc/src/man/rmr_get_meid.3.xfm +++ b/doc/src/man/rmr_get_meid.3.xfm @@ -44,20 +44,20 @@ char* rmr_get_meid( rmr_mbuf_t* mbuf, unsigned char* dest ) &uindent &h2(DESCRIPTION) -The &cw(rmr_get_meid) function will copy the managed equipment ID (meid) field from the message +The &cw(rmr_get_meid) function will copy the managed entity ID (meid) 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_MEID) 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_MEID) 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 @@ -79,6 +79,7 @@ rmr_bytes2meid(3), rmr_call(3), rmr_free_msg(3), rmr_get_rcvfd(3), +rmr_get_xact(3), rmr_payload_size(3), rmr_send_msg(3), rmr_rcv_msg(3), @@ -96,6 +97,3 @@ rmr_wh_open(3), rmr_wh_send_msg(3) .ju on - -.qu -