X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=doc%2Fsrc%2Fman%2Frmr_get_meid.3.xfm;h=5745e041b56df160e63f44880db9a81a71211990;hb=5a9d175bb17fcc71aa19fc23458e485830b97e0a;hp=d31bb3c00be464e9f74358113bba3940d42f0c1e;hpb=b7a4b52f73d51db6077d2c0b56be262c36f472f7;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 d31bb3c..5745e04 100644 --- a/doc/src/man/rmr_get_meid.3.xfm +++ b/doc/src/man/rmr_get_meid.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_meid.xfm - Abstract The manual page for the rmr_get_meid function. - Author E. Scott Daniels - Date 8 March 2019 + Mnemonic rmr_get_meid.xfm + Abstract The manual page for the rmr_get_meid function. + Author E. Scott Daniels + Date 8 March 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_meid + rmr_get_meid &h2(SYNOPSIS) &indent @@ -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 -into the &ital(dest) buffer provided by the user. +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 to free when the buffer is no longer needed). &h2(RETURN VALUE) -On success, a pointer to the extracted string is returned. +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 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,8 +65,8 @@ 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 - buffer using malloc(). +&di(ENOMEM) A nil pointer was passed for &ital(dest,) however it was not possible to allocate a + buffer using malloc(). &end_dlist