Public API


Detailed Description

The NetWeaver RFC C API allows custom C programs to


Modules

 General API & Utilities
 Some utility functions for initializing, tracing, version info, etc.
 Connection related API
 Opening and closing client & server connections.
 Transaction (tRFC & qRFC) API
 Functions for sending transactional and queued RFCs into R/3.
 Background Communication (bgRFC) API
 Functions for sending background RFC units into R/3.
 Installation of Callback Functions for RFC Servers
 These functions install the necessary callback functions that allow RFC servers to process incoming RFC, tRFC, qRFC and bgRFC calls.
 Data container API (Function objects, structures & tables)
 Functions for allocating & releasing data containers, which hold the data of a structure, table or complete function module.
 Metadata and Repository API
 Functions for creating and looking up metadata descriptions in the R/3 DDIC.

Classes

struct  _RFC_ERROR_INFO
 Used in all functions of the NW RFC library to return detailed information about an error that has just occurred. More...

Enumerations

enum  _RFCTYPE {
  RFCTYPE_CHAR = 0, RFCTYPE_DATE = 1, RFCTYPE_BCD = 2, RFCTYPE_TIME = 3,
  RFCTYPE_BYTE = 4, RFCTYPE_TABLE = 5, RFCTYPE_NUM = 6, RFCTYPE_FLOAT = 7,
  RFCTYPE_INT = 8, RFCTYPE_INT2 = 9, RFCTYPE_INT1 = 10, RFCTYPE_NULL = 14,
  RFCTYPE_ABAPOBJECT = 16, RFCTYPE_STRUCTURE = 17, RFCTYPE_DECF16 = 23, RFCTYPE_DECF34 = 24,
  RFCTYPE_XMLDATA = 28, RFCTYPE_STRING = 29, RFCTYPE_XSTRING = 30, RFCTYPE_INT8,
  RFCTYPE_UTCLONG, RFCTYPE_UTCSECOND, RFCTYPE_UTCMINUTE, RFCTYPE_DTDAY,
  RFCTYPE_DTWEEK, RFCTYPE_DTMONTH, RFCTYPE_TSECOND, RFCTYPE_TMINUTE,
  RFCTYPE_CDAY, RFCTYPE_BOX, RFCTYPE_GENERIC_BOX, _RFCTYPE_max_value
}
 RFCTYPE is used in field descriptions (RFC_FIELD_DESC) and parameter descriptions (RFC_PARAMETER_DESC) and denotes the ABAP data type of the corresponding field/parameter. More...
enum  _RFC_RC {
  RFC_OK, RFC_COMMUNICATION_FAILURE, RFC_LOGON_FAILURE, RFC_ABAP_RUNTIME_FAILURE,
  RFC_ABAP_MESSAGE, RFC_ABAP_EXCEPTION, RFC_CLOSED, RFC_CANCELED,
  RFC_TIMEOUT, RFC_MEMORY_INSUFFICIENT, RFC_VERSION_MISMATCH, RFC_INVALID_PROTOCOL,
  RFC_SERIALIZATION_FAILURE, RFC_INVALID_HANDLE, RFC_RETRY, RFC_EXTERNAL_FAILURE,
  RFC_EXECUTED, RFC_NOT_FOUND, RFC_NOT_SUPPORTED, RFC_ILLEGAL_STATE,
  RFC_INVALID_PARAMETER, RFC_CODEPAGE_CONVERSION_FAILURE, RFC_CONVERSION_FAILURE, RFC_BUFFER_TOO_SMALL,
  RFC_TABLE_MOVE_BOF, RFC_TABLE_MOVE_EOF, RFC_START_SAPGUI_FAILURE, RFC_ABAP_CLASS_EXCEPTION,
  RFC_UNKNOWN_ERROR, RFC_AUTHORIZATION_FAILURE, _RFC_RC_max_value
}
 RFC return codes used by all functions that do not directly return a handle. More...
enum  _RFC_ERROR_GROUP {
  OK, ABAP_APPLICATION_FAILURE, ABAP_RUNTIME_FAILURE, LOGON_FAILURE,
  COMMUNICATION_FAILURE, EXTERNAL_RUNTIME_FAILURE, EXTERNAL_APPLICATION_FAILURE, EXTERNAL_AUTHORIZATION_FAILURE
}
 Groups several error conditions together, depending on the "layer" to which they belong. More...


Enumeration Type Documentation

Groups several error conditions together, depending on the "layer" to which they belong.

Used in the structure RFC_ERROR_INFO::group.

Enumerator:
OK  OK.
ABAP_APPLICATION_FAILURE  ABAP Exception raised in ABAP function modules.
ABAP_RUNTIME_FAILURE  ABAP Message raised in ABAP function modules or in ABAP runtime of the backend (e.g Kernel).
LOGON_FAILURE  Error message raised when logon fails.
COMMUNICATION_FAILURE  Problems with the network connection (or backend broke down and killed the connection).
EXTERNAL_RUNTIME_FAILURE  Problems in the RFC runtime of the external program (i.e "this" library).
EXTERNAL_APPLICATION_FAILURE  Problems in the external program (e.g in the external server implementation).
EXTERNAL_AUTHORIZATION_FAILURE  Problems raised in the authorization check handler provided by the external server implementation.

Definition at line 172 of file sapnwrfc.h.

enum _RFC_RC

RFC return codes used by all functions that do not directly return a handle.

Also used as error indicator in the structure RFC_ERROR_INFO::code.

Enumerator:
RFC_OK  Everything O.K. Used by every function.
RFC_COMMUNICATION_FAILURE  Error in Network & Communication layer.
RFC_LOGON_FAILURE  Unable to logon to SAP system. Invalid password, user locked, etc.
RFC_ABAP_RUNTIME_FAILURE  SAP system runtime error (SYSTEM_FAILURE): Shortdump on the backend side.
RFC_ABAP_MESSAGE  The called function module raised an E-, A- or X-Message.
RFC_ABAP_EXCEPTION  The called function module raised an Exception (RAISE or MESSAGE ... RAISING).
RFC_CLOSED  Connection closed by the other side.
RFC_CANCELED  No longer used.
RFC_TIMEOUT  Time out.
RFC_MEMORY_INSUFFICIENT  Memory insufficient.
RFC_VERSION_MISMATCH  Version mismatch.
RFC_INVALID_PROTOCOL  The received data has an unsupported format.
RFC_SERIALIZATION_FAILURE  A problem while serializing or deserializing RFM parameters.
RFC_INVALID_HANDLE  An invalid handle was passed to an API call.
RFC_RETRY  RfcListenAndDispatch did not receive an RFC request during the timeout period.
RFC_EXTERNAL_FAILURE  Error in external custom code. (E.g in the function handlers or tRFC handlers.) Results in SYSTEM_FAILURE.
RFC_EXECUTED  Inbound tRFC Call already executed (needs to be returned from RFC_ON_CHECK_TRANSACTION in case the TID is already known and successfully processed before.).
RFC_NOT_FOUND  Function or structure definition not found (Metadata API).
RFC_NOT_SUPPORTED  The operation is not supported on that handle.
RFC_ILLEGAL_STATE  The operation is not supported on that handle at the current point of time (e.g trying a callback on a server handle, while not in a call).
RFC_INVALID_PARAMETER  An invalid parameter was passed to an API call, (e.g invalid name, type or length).
RFC_CODEPAGE_CONVERSION_FAILURE  Codepage conversion error.
RFC_CONVERSION_FAILURE  Error while converting a parameter to the correct data type.
RFC_BUFFER_TOO_SMALL  The given buffer was to small to hold the entire parameter. Data has been truncated.
RFC_TABLE_MOVE_BOF  Trying to move the current position before the first row of the table.
RFC_TABLE_MOVE_EOF  Trying to move the current position after the last row of the table.
RFC_START_SAPGUI_FAILURE  Failed to start and attach SAPGUI to the RFC connection.
RFC_ABAP_CLASS_EXCEPTION  The called function module raised a class based exception.
RFC_UNKNOWN_ERROR  "Something" went wrong, but I don't know what...
RFC_AUTHORIZATION_FAILURE  Authorization check error.
_RFC_RC_max_value  Don't use.

Definition at line 131 of file sapnwrfc.h.

enum _RFCTYPE

RFCTYPE is used in field descriptions (RFC_FIELD_DESC) and parameter descriptions (RFC_PARAMETER_DESC) and denotes the ABAP data type of the corresponding field/parameter.

Enumerator:
RFCTYPE_CHAR  1-byte or multibyte character, fixed size, blank padded
RFCTYPE_DATE  Date ( YYYYYMMDD ).
RFCTYPE_BCD  Packed number, any length between 1 and 16 bytes.
RFCTYPE_TIME  Time (HHMMSS).
RFCTYPE_BYTE  Raw data, binary, fixed length, zero padded.
RFCTYPE_TABLE  Internal table.
RFCTYPE_NUM  Digits, fixed size, leading '0' padded.
RFCTYPE_FLOAT  Floating point, double precision.
RFCTYPE_INT  4-byte integer
RFCTYPE_INT2  2-byte integer. Obsolete, not directly supported by ABAP/4
RFCTYPE_INT1  1-byte integer, unsigned. Obsolete, not directly supported by ABAP/4
RFCTYPE_NULL  Not supported data type.
RFCTYPE_ABAPOBJECT  ABAP object.
RFCTYPE_STRUCTURE  ABAP structure.
RFCTYPE_DECF16  IEEE 754r decimal floating point, 8 bytes.
RFCTYPE_DECF34  IEEE 754r decimal floating point, 16 bytes.
RFCTYPE_XMLDATA  No longer used!
RFCTYPE_STRING  Variable-length, null-terminated string.
RFCTYPE_XSTRING  Variable-length raw string, length in bytes.
RFCTYPE_INT8  8-byte integer
RFCTYPE_UTCLONG  timestamp/long, 8-byte integer
RFCTYPE_UTCSECOND  timestamp/second, 8-byte integer
RFCTYPE_UTCMINUTE  timestamp/minute, 8-byte integer
RFCTYPE_DTDAY  date/day , 4-byte integer
RFCTYPE_DTWEEK  date/week, 4-byte integer
RFCTYPE_DTMONTH  date/month, 4-byte integer
RFCTYPE_TSECOND  time/second, 4-byte integer
RFCTYPE_TMINUTE  time/minute, 2-byte integer
RFCTYPE_CDAY  calendar day, 2-byte integer
RFCTYPE_BOX  boxed structure, note: not supported by NW RFC lib
RFCTYPE_GENERIC_BOX  boxed client dependent structure, note: not supported by NW RFC lib
_RFCTYPE_max_value  the max. value of RFCTYPEs

Definition at line 89 of file sapnwrfc.h.


Generated on Tue Feb 22 13:18:17 2011 for SAP by  doxygen 1.5.5