docs/rmr_get_const.3.rst

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