X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=doc%2Fsrc%2Fman%2Frmr_str2meid.3.xfm;h=d4ece5f771afb89a27466b88cdd5f65c29e5ef12;hb=7be490e08653896748ed6390cf74a2cc97f4bf50;hp=81ed6c90db6f9b0431b5785109e258674df796e1;hpb=fd9cc7a5b3355146388ebdf4d558cb284c66c5f1;p=ric-plt%2Flib%2Frmr.git diff --git a/doc/src/man/rmr_str2meid.3.xfm b/doc/src/man/rmr_str2meid.3.xfm index 81ed6c9..d4ece5f 100644 --- a/doc/src/man/rmr_str2meid.3.xfm +++ b/doc/src/man/rmr_str2meid.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,31 +18,20 @@ .fi .if false - Mnemonic rmr_str2meid.xfm - Abstract The manual page for the rmr_str2meid function. - Author E. Scott Daniels - Date 8 March 2019 + Mnemonic rmr_str2meid.xfm + Abstract The manual page for the rmr_str2meid 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_str2meid + rmr_str2meid &h2(SYNOPSIS) &indent @@ -55,15 +44,15 @@ int rmr_str2meid( rmr_mbuf_t* mbuf, unsigned char* src, int len ) &uindent &h2(DESCRIPTION) -The &cw(rmr_str2meid) function will copy the string pointed to by src to the -managed equipment ID (meid) field in the given message. +The &cw(rmr_str2meid) function will copy the string pointed to by src to the +managed entity ID (meid) field in the given message. The field is a fixed length, gated by the constant &cw(RMR_MAX_MEID) and if string length is larger than this value, then &bold(nothing) will be copied. (Note, this differs slightly from the -behaviour of the &cw( lrmr_bytes2meid() ) function.) +behaviour of the &cw(lrmr_bytes2meid()) function.) &h2(RETURN VALUE) -On success, the value RMR_OK is returned. -If the string cannot be copied to the message, the return value will be one of the +On success, the value RMR_OK is returned. +If the string cannot be copied to the message, the return value will be one of the errors listed below. &h2(ERRORS) @@ -76,7 +65,7 @@ If the return value is not RMR_OK, then it will be set to one of the values belo &half_space &di(RMR_ERR_OVERFLOW) The length passed in was larger than the maximum length of the field; only a portion of - the source bytes were copied. + the source bytes were copied. &end_dlist &h2(EXAMPLE) @@ -104,5 +93,4 @@ rmr_bytes2meid(3), rmr_wh_open(3), rmr_wh_send_msg(3) .ju on -.qu