3 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
4 .. SPDX-License-Identifier: CC-BY-4.0
5 .. CAUTION: this document is generated from source in doc/src/rtd.
6 .. To make changes edit the source and recompile the document.
7 .. Do NOT make changes directly to .rst or .md files.
10 ============================================================================================
11 Man Page: rmr_get_const
12 ============================================================================================
15 ============================================================================================
19 --------------------------------------------------------------------------------------------
24 --------------------------------------------------------------------------------------------
30 unsigned char* rmr_get_const();
35 --------------------------------------------------------------------------------------------
37 The rmr_get_const function is a convenience function for
38 wrappers which do not have the ability to "compile in" RMR
39 constants. The function will build a nil terminated string
40 containing JSON which defines the RMR constants that C and Go
41 applications have at compile time via the rmr.h header file.
43 All values are represented as strings and the JSON format is
44 illustrated in the following (partial) example:
52 "RMR_ERR_BADARG", "1",
59 --------------------------------------------------------------------------------------------
61 On success, a pointer to a string containing the JSON
62 defining constant and value pairs. On failure a nil pointer
66 --------------------------------------------------------------------------------------------