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=5157a97ada5447efcee4da6192798a3b6799884c;hp=2dcc9436a98d88dba823397b0e8cd33db550ee9a;hpb=fd9cc7a5b3355146388ebdf4d558cb284c66c5f1;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 2dcc943..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,57 +18,46 @@ .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 -.** if formatting with tfm, the roff.im will cause roff output to be generated -.** if formatting with pfm, then pretty postscript will be generated .gv e LIB lib -.if pfm - .im &{lib}/generic_ps.im -.ei - .gv e OUTPUT_RST use_rst - .if .ev &use_rst 1 = - .im &{lib}/rst.im - .ei - .im &{lib}/roff.im - .fi -.fi +.im &{lib}/man/setup.im &line_len(6i) &h1(RMR Library Functions) &h2(NAME) - rmr_get_meid + rmr_get_meid &h2(SYNOPSIS) &indent &ex_start #include -int rmr_get_meid( rmr_mbuf_t* mbuf, unsigned char* dest ) +char* rmr_get_meid( rmr_mbuf_t* mbuf, unsigned char* dest ) &ex_end &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 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 &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. -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. +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 ) @@ -76,9 +65,9 @@ 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(). -&end_dilist +&di(ENOMEM) A nil pointer was passed for &ital(dest,) however it was not possible to allocate a + buffer using malloc(). +&end_dlist @@ -90,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), @@ -107,6 +97,3 @@ rmr_wh_open(3), rmr_wh_send_msg(3) .ju on - -.qu -