RMC API data definitions

Edit online

The RMC API includes several macros and datatypes that simplify the task of programming the API, provide more complete error checking during compilation, and hide implementation details.

This information will help you understand the subroutine parameters described in RMC API subroutines.

The RMC API data declarations are contained in the header file rsct/ct_mc.h. The definitions in this header file are prefixed by mc_, in appropriate case. The rsct/ct_mc.h header file also includes the following header files:

ct_mcerr.h: Definitions of error codes, prefixed by RMC_, and descriptions of error arguments that can be returned in responses and event notifications. These error codes are summarized in RMC API error codes and return values.
ct_rmc.h: Definitions, prefixed by rmc_, that are common to several cluster APIs
ct_cu.h: Definitions, prefixed by cu_, for the cluster common utilities API.
ct.h: Definitions, prefixed by ct_, that are common to all cluster APIs.

In order to use the version of the RMC API described here, the rsct/ct_mc.h header file must be preceded by the MC_VERSION macro definition, as shown in the following:

#define MC_VERSION 6
#include <rsct/ct_mc.h>

You can also, instead of defining the MC_VERSION and including the rsct/ct_mc.h header file, include the header file rsct/ct_mc_v6.h. This header file defines the MC_VERSION and includes the rsct/ct_mc.h header file.