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_get_meid.xfm
22 Abstract The manual page for the rmr_get_meid function.
23 Author E. Scott Daniels
28 .im &{lib}/man/setup.im
32 &h1(RMR Library Functions)
41 char* rmr_get_meid( rmr_mbuf_t* mbuf, unsigned char* dest )
47 The &cw(rmr_get_meid) function will copy the managed equipment ID (meid) field from the message
48 into the &ital(dest) buffer provided by the user.
49 The buffer referenced by &ital( dest ) is assumed to be at least &cw(RMR_MAX_MEID) bytes in length.
50 If &ital( dest ) is NULL, then a buffer is allocated (the calling application is expected
51 to free when the buffer is no longer needed).
54 On success, a pointer to the extracted string is returned.
55 If &ital( dest ) was supplied, then this is just a pointer to the caller's buffer.
56 If &ital( dest ) was NULL, this is a pointer to the allocated buffer.
57 If an error occurs, a nil pointer is returned and errno is set as described below.
60 If an error occurs, the value of the global variable &cw( errno ) will be set to one of
61 the following with the indicated meaning.
63 &beg_dlist(.75i : ^&bold_font )
65 &di(EINVAL) The message, or an internal portion of the message, was corrupted or the pointer was invalid.
68 &di(ENOMEM) A nil pointer was passed for &ital( dest, ) however it was not possible to allocate a
69 buffer using malloc().