2 ==================================================================================
3 Copyright (c) 2020 Nokia
4 Copyright (c) 2020 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_const.xfm
22 Abstract The manual page for the rmr_get_const function.
23 Author E. Scott Daniels
28 .im &{lib}/man/setup.im
32 &h1(RMR Library Functions)
41 unsigned char* rmr_get_const();
47 The &cw(rmr_get_const) function is a convenience function for wrappers which do not have
48 the ability to "compile in" RMR constants.
49 The function will build a nil terminated string containing JSON which defines the
50 RMR constants that C and Go applications have at compile time via the &cw(rmr.h) header file.
53 All values are represented as strings and the JSON format is illustrated in the following (partial)
61 "RMR_ERR_BADARG", "1",
67 On success, a pointer to a string containing the JSON defining constant and value pairs.
68 On failure a nil pointer is returned.