SAP NetWeaver RFC SDK 7.50
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
doxyfile_nrfc_public.h
Go to the documentation of this file.
1 /* $Id: //bas/753_REL/src/krn/rfc/nrfc/doxyfile_nrfc_public.h#3 $ SAP
2  *
3  * Maintainer: Ulrich Schmidt
4  * Topic: RFC
5  *
6  */
7 
8 /**
9  * \file doxyfile_nrfc_public.h
10  * Make sure some meaningfull values are pulled in first
11  * instead of one of the many dummies. This is done to avoid pulling
12  * saptype.h first.
13  *
14  * \mainpage SAP NetWeaver RFC SDK
15  *
16  * \image html ABAP_Docu_Logo.gif
17  *
18  * The ABAP NWRFC is organized around the following topics:
19  *
20  * - \ref api
21  */
22 
23 #if defined(DOXYGEN_MAKE) && 1
24 
25 #define SAP_O_K 0 /**< successful operation */
26 #define TRUE 1 /**< boolean value */
27 #define FALSE 0 /**< boolean value */
28 
29 typedef charU SAP_UC; /**< unicode character */
30 typedef unsigned char SAP_BOOL; /**< boolean type for values #TRUE
31  * and #FALSE */
32 typedef unsigned char SAP_RAW; /**< unsigned 1 byte integer */
33 typedef int2 SAP_SHORT; /**< signed 2 byte integer */
34 typedef unsigned int2 SAP_USHORT; /**< unsigned 2 byte integer */
35 typedef int4 SAP_INT; /**< signed 4 byte integer */
36 typedef unsigned int4 SAP_UINT; /**< unsigned 4 byte integer */
37 typedef SAP_INT SAPRETURN; /**< function return type (signed
38  * 4 byte integer) */
39 
40 #endif /* DOXYGEN_MAKE */
41 
42 /**
43  * \defgroup api Public API
44  *
45  * The NetWeaver RFC C API allows custom C programs to
46  * - query the R/3 DDIC for function module and structure definitions
47  * - call ABAP function modules in R/3
48  * - receive ABAP function calls from R/3 and
49  * - create/read/write/traverse the data containers necessary for the above.
50  */
51 
52 /**
53  * \defgroup general General API & Utilities
54  * \ingroup api
55  *
56  * Some utility functions for initializing, tracing, version info, etc.
57  */
58 
59 /**
60  * \defgroup connection Connection related API
61  * \ingroup api
62  *
63  * Opening and closing client & server connections.
64  */
65 
66 /**
67  * \defgroup autoserver API for Automated Servers
68  * \ingroup connection
69  *
70  * Functions for managing "automated" Servers (also called "multi-count" Servers).
71  */
72 
73 /**
74  * \defgroup transaction Transaction (tRFC & qRFC) API
75  * \ingroup api
76  *
77  * Functions for sending transactional and queued RFCs into R/3.
78  */
79 
80 /**
81  * \defgroup bgrfc Background Communication (bgRFC) API
82  * \ingroup api
83  *
84  * Functions for sending background RFC units into R/3.
85  */
86 
87 /**
88  * \defgroup installer Installation of Callback Functions for RFC Servers
89  * \ingroup api
90  *
91  * These functions install the necessary callback functions that allow RFC servers
92  * to process incoming RFC, tRFC, qRFC and bgRFC calls.
93  */
94 
95 /**
96  * \defgroup container Data container API (Function objects, structures & tables)
97  * \ingroup api
98  *
99  * Functions for allocating & releasing data containers, which hold the data of
100  * a structure, table or complete function module.
101  */
102 
103 /**
104  * \defgroup repository Metadata and Repository API
105  * \ingroup api
106  *
107  * Functions for creating and looking up metadata descriptions in the R/3 DDIC.
108  * Functions for traversing through metadata descriptions.
109  */
110 
111 /**
112  * \defgroup throughput JCo-like Throughput API
113  * \ingroup api
114  *
115  * Functions for creating, destroying and working with throughput objects,
116  * which can be used to monitor performance relevant data of connections and servers.
117  */
118 
119 /**
120  * \defgroup structure Metadata for structures/line-types
121  * \ingroup repository
122  *
123  * Functions for creating, reading and traversing through structure descriptions.
124  */
125 
126 /**
127  * \defgroup function Metadata for function modules
128  * \ingroup repository
129  *
130  * Functions for creating, reading and traversing through function module descriptions.
131  */
132 
133 /**
134  * \defgroup class Metadata for ABAP classes
135  * \ingroup repository
136  *
137  * Functions for creating, reading and traversing through ABAP class descriptions.
138  */
139 
unsigned char SAP_RAW
unsigned 1 byte integer
unsigned int4 SAP_UINT
unsigned 4 byte integer
int2 SAP_SHORT
signed 2 byte integer
SAP_INT SAPRETURN
function return type (signed 4 byte integer)
charU SAP_UC
unicode character
int4 SAP_INT
signed 4 byte integer
unsigned char SAP_BOOL
boolean type for values TRUE and FALSE
unsigned int2 SAP_USHORT
unsigned 2 byte integer