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