doc/src/man/rmr_get_const.3.xfm

   1 .if false
   2 ==================================================================================
   3    Copyright (c) 2020 Nokia
   4    Copyright (c) 2020 AT&T Intellectual Property.
   5
   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
   9
  10        http://www.apache.org/licenses/LICENSE-2.0
  11
  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 ==================================================================================
  18 .fi
  19
  20 .if false
  21     Mnemonic    rmr_get_const.xfm
  22     Abstract    The manual page for the rmr_get_const function.
  23     Author      E. Scott Daniels
  24     Date        10 April 2020
  25 .fi
  26
  27 .gv e LIB lib
  28 .im &{lib}/man/setup.im
  29
  30 &line_len(6i)
  31
  32 &h1(RMR Library Functions)
  33 &h2(NAME)
  34     rmr_get_const
  35
  36 &h2(SYNOPSIS)
  37 &indent
  38 &ex_start
  39 #include <rmr/rmr.h>
  40
  41 unsigned char* rmr_get_const();
  42 &ex_end
  43
  44 &uindent
  45
  46 &h2(DESCRIPTION)
  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.
  51 .sp
  52
  53 All values are represented as strings and the JSON format is illustrated in the following (partial)
  54 example:
  55 &half_space
  56
  57 &ex_start
  58 {
  59   "RMR_MAX_XID": "32",
  60   "RMR_OK": "0",
  61   "RMR_ERR_BADARG", "1",
  62   "RMR_ERR_NOENDPT" "2"
  63 }
  64 &ex_end
  65
  66 &h2(RETURN VALUE)
  67 On success, a pointer to a string containing the JSON defining constant and value pairs.
  68 On failure a nil pointer is returned.
  69
  70
  71 &h2(SEE ALSO )
  72 .ju off
  73 rmr(7)
  74 .ju on
  75