2 ==================================================================================
3 Copyright (c) 2019 Nokia
4 Copyright (c) 2018-2019 AT&T Intellectual Property.
6 Licensed under the Apache License, Version 2.0 (the "License");
7 you may not use this file except in compliance with the License.
8 You may obtain a copy of the License at
10 http://www.apache.org/licenses/LICENSE-2.0
12 Unless required by applicable law or agreed to in writing, software
13 distributed under the License is distributed on an "AS IS" BASIS,
14 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 See the License for the specific language governing permissions and
16 limitations under the License.
17 ==================================================================================
21 Mnemonic rmr_bytes2meid.xfm
22 Abstract The manual page for the rmr_bytes2meid function.
23 Author E. Scott Daniels
27 .** if formatting with tfm, the roff.im will cause roff output to be generated
28 .** if formatting with pfm, then pretty postscript will be generated
31 .im &{lib}/generic_ps.im
33 .gv e OUTPUT_RST use_rst
43 &h1(RMR Library Functions)
52 int rmr_bytes2meid( rmr_mbuf_t* mbuf, unsigned char* src, int len )
58 The &cw(rmr_bytes2meid) function will copy up to &ital(len) butes from &ital(src) to the
59 managed equipment ID (meid) field in the message.
60 The field is a fixed length, gated by the constant &cw(RMR_MAX_MEID) and if len is larger
61 than this value, only RMR_MAX_MEID bytes will actually be copied.
65 On success, the actual number of bytes copied is returned, or -1 to indicate a hard error.
66 If the length is less than 0, or not the same as length passed in, &cw(errno) is set
67 to one of the errors described in the &ital(Errors) section.
70 If the returned length does not match the length passed in, &cw(errno) will be set to one
71 of the following constants with the meaning listed below.
73 &beg_dlist(.75i : ^&bold_font )
75 &di(EINVAL) The message, or an internal portion of the message, was corrupted or the pointer was invalid.
78 &di(EOVERFLOW) The length passed in was larger than the maximum length of the field; only a portion of
79 the source bytes were copied.