docs/rmr_get_const.3.rst

   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.
   6
   7 ============================================================================================
   8 Man Page: rmr_get_const
   9 ============================================================================================
  10
  11
  12
  13
  14 RMR LIBRARY FUNCTIONS
  15 =====================
  16
  17
  18
  19 NAME
  20 ----
  21
  22 rmr_get_const
  23
  24
  25 SYNOPSIS
  26 --------
  27
  28
  29 ::
  30
  31   #include <rmr/rmr.h>
  32
  33   unsigned char* rmr_get_const();
  34
  35
  36
  37 DESCRIPTION
  38 -----------
  39
  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
  45 file.
  46
  47 All values are represented as strings and the JSON format is
  48 illustrated in the following (partial) example:
  49
  50
  51 ::
  52
  53   {
  54     "RMR_MAX_XID": "32",
  55     "RMR_OK": "0",
  56     "RMR_ERR_BADARG", "1",
  57     "RMR_ERR_NOENDPT" "2"
  58   }
  59
  60
  61
  62 RETURN VALUE
  63 ------------
  64
  65 On success, a pointer to a string containing the JSON
  66 defining constant and value pairs. On failure a nil pointer
  67 is returned.
  68
  69
  70 SEE ALSO
  71 --------
  72
  73 rmr(7)