doxyfile_nrfc_public.h

Go to the documentation of this file.

/* $Id: //bas/753_REL/src/krn/rfc/nrfc/doxyfile_nrfc_public.h#3 $ SAP
 *
 * Maintainer:   Ulrich Schmidt
 * Topic:        RFC
 *  
 */

/**
 * \file doxyfile_nrfc_public.h 
 * Make sure some meaningfull values are pulled in first 
 * instead of one of the many dummies.  This is done to avoid pulling
 * saptype.h first.
 *
 * \mainpage SAP NetWeaver RFC SDK 
 *
 * \image html ABAP_Docu_Logo.gif
 *
 * The ABAP NWRFC is organized around the following topics:
 *
 * - \ref api
 */
 
#if   defined(DOXYGEN_MAKE) && 1

#define SAP_O_K   0   /**< successful operation                       */
#define TRUE      1   /**< boolean value                              */
#define FALSE     0   /**< boolean value                              */

typedef charU         SAP_UC;       /**< unicode character            */
typedef unsigned char SAP_BOOL;     /**< boolean type for values #TRUE
                                     *   and #FALSE                   */
typedef unsigned char SAP_RAW;      /**< unsigned 1 byte integer      */
typedef int2          SAP_SHORT;    /**< signed 2 byte integer        */
typedef unsigned int2 SAP_USHORT;   /**< unsigned 2 byte integer      */
typedef int4          SAP_INT;      /**< signed 4 byte integer        */
typedef unsigned int4 SAP_UINT;     /**< unsigned 4 byte integer      */
typedef SAP_INT       SAPRETURN;    /**< function return type (signed
                                     *   4 byte integer)              */

#endif /* DOXYGEN_MAKE */

/**
 * \defgroup api  Public API
 *
 * The NetWeaver RFC C API allows custom C programs to
 * - query the R/3 DDIC for function module and structure definitions
 * - call ABAP function modules in R/3
 * - receive ABAP function calls from R/3 and
 * - create/read/write/traverse the data containers necessary for the above.
 */

/**
 * \defgroup general General API & Utilities
 * \ingroup api
 *
 * Some utility functions for initializing, tracing, version info, etc.
 */

/**
 * \defgroup connection  Connection related API
 * \ingroup api
 *
 * Opening and closing client & server connections.
 */

/**
 * \defgroup autoserver  API for Automated Servers
 * \ingroup connection
 *
 * Functions for managing "automated" Servers (also called "multi-count" Servers).
 */

/**
 * \defgroup transaction  Transaction (tRFC & qRFC) API
 * \ingroup api
 *
 * Functions for sending transactional and queued RFCs into R/3.
 */

/**
 * \defgroup bgrfc  Background Communication (bgRFC) API
 * \ingroup api
 *
 * Functions for sending background RFC units into R/3.
 */

/**
 * \defgroup installer  Installation of Callback Functions for RFC Servers
 * \ingroup api
 *
 * These functions install the necessary callback functions that allow RFC servers
 * to process incoming RFC, tRFC, qRFC and bgRFC calls.
 */

/**
 * \defgroup container  Data container API (Function objects, structures & tables)
 * \ingroup api
 *
 * Functions for allocating & releasing data containers, which hold the data of
 * a structure, table or complete function module.
 */

/**
 * \defgroup repository  Metadata and Repository API
 * \ingroup api
 *
 * Functions for creating and looking up metadata descriptions in the R/3 DDIC.
 * Functions for traversing through metadata descriptions.
 */

/**
 * \defgroup throughput  JCo-like Throughput API
 * \ingroup api
 *
 * Functions for creating, destroying and working with throughput objects,
 * which can be used to monitor performance relevant data of connections and servers.
 */

/**
 * \defgroup structure  Metadata for structures/line-types
 * \ingroup repository
 *
 * Functions for creating, reading and traversing through structure descriptions.
 */

/**
 * \defgroup function  Metadata for function modules
 * \ingroup repository
 *
 * Functions for creating, reading and traversing through function module descriptions.
 */

/**
 * \defgroup class  Metadata for ABAP classes
 * \ingroup repository
 *
 * Functions for creating, reading and traversing through ABAP class descriptions.
 */