SAP C_OI_ERRORS OO Class - Error Handling for Office Integration









C_OI_ERRORS is a standard SAP object class available within R/3 SAP systems depending on your version and release level. You can view/maintain the class details by entering its name into the relevant SAP transactions such as SE24, SE80 or even SE84. Below is the documentation available for class C_OI_ERRORS including details of:

  • Interface class implementations
  • Inheritance details
  • Methods defined within class ( including link to full details )
  • Attributes ( including initial values )
  • Class Events



Method list of C_OI_ERRORS SAP class


A method is a coding block that performs a certain procedure (i.e. ABAP functionality) on an object within the overall SAP class. In simple terms if the object is an SAP database table a method could be the procedure to add a record or to delete a record. If you are new to OO in many respects, the implementation of a method is similar to a function module and can be called in a very similar way using CALL METHOD. Instead of "CALL FUNCTION", Methods are referenced using the following syntax: CALL METHOD =>methodname EXPORTING/IMPORTING...


Method NameDescriptionVisability
ADD_ERRORFor Internal UsePublic
CALL METHOD c_oi_errors=>ADD_ERROR...more details

CREATE_ERROR_FOR_RETCODEFor Internal UsePublic
CALL METHOD c_oi_errors=>CREATE_ERROR_FOR_RETCODE...more details

FLUSH_ERRORSFor Internal UsePublic
CALL METHOD c_oi_errors=>FLUSH_ERRORS...more details

GET_MESSAGEReturns Error DataPublic
CALL METHOD c_oi_errors=>GET_MESSAGE...more details

RAISE_MESSAGETriggers Error Display for ErrorPublic
CALL METHOD c_oi_errors=>RAISE_MESSAGE...more details

SET_ERROR_CODEFor Internal UsePublic
CALL METHOD c_oi_errors=>SET_ERROR_CODE...more details

SET_MESSAGEFor Internal UsePublic
CALL METHOD c_oi_errors=>SET_MESSAGE...more details

SET_MESSAGE_FOR_ERRORFor Internal UsePublic
CALL METHOD c_oi_errors=>SET_MESSAGE_FOR_ERROR...more details

SHOW_MESSAGETriggers Error Display for ErrorPublic
CALL METHOD c_oi_errors=>SHOW_MESSAGE...more details

TRANSLATE_PROXY_ERROR_CODEFor Internal UsePublic
CALL METHOD c_oi_errors=>TRANSLATE_PROXY_ERROR_CODE...more details



C_OI_ERRORS attributes

List of attributes within class CL_ABAP_CHAR_UTILITIES. These can be referenced using the following syntax CL_ABAP_CHAR_UTILITIES=>. Although depending on where you are inserting the ABAP code you do need to check if the attribute is public or private.

NameLevelDescriptionInitial ValueTypeVisability
ERROR_CODEStatic AttributeError CodeLIKE
SOI_RET_STRING
Public
ERROR_LISTStatic AttributeError listLIKE
Private
HAS_FAILEDStatic Attribute'X' - FailedLIKE
CHAR1
Public
HAS_SUCCEEDEDStatic Attribute'X' - SucceededLIKE
CHAR1
Public
MESSAGE_IDStatic AttributeFor Internal UseLIKE
SY-MSGID
Private
MESSAGE_NRStatic AttributeFor Internal UseLIKE
SY-MSGNO
Private
NEEDS_FLUSHStatic AttributeFor Internal UseLIKE
CHAR1
Private
PARAM1Static AttributeFor Internal UseLIKE
SY-MSGV1
Private
PARAM2Static AttributeFor Internal UseLIKE
SY-MSGV2
Private
PARAM3Static AttributeFor Internal UseLIKE
SY-MSGV3
Private
PARAM4Static AttributeFor Internal UseLIKE
SY-MSGV4
Private
RET_APPLICATION_NOT_RESPONDINGConstantApplication Is Not Responding Or Is Busy'APPLICATION_NOT_RESPONDING'LIKE
SOI_RET_STRING
Public
RET_CALL_NOT_FLUSHEDConstantCall not Executed'CALL_NOT_FLUSHED'LIKE
SOI_RET_STRING
Public
RET_CONTROL_CREATE_ERRORConstantControl Not Created'CONTROL_CREATE_ERROR'LIKE
SOI_RET_STRING
Public
RET_CONTROL_ERRORConstantGeneral Error'CONTROL_ERROR'LIKE
SOI_RET_STRING
Public
RET_CONTROL_INSTALL_ERRORConstantInstallation errors'CONTROL_INSTALL_ERROR'LIKE
SOI_RET_STRING
Public
RET_CONTROL_INTERNAL_ERRORConstantInternal error'CONTROL_INTERNAL_ERROR'LIKE
SOI_RET_STRING
Public
RET_CONTROL_NOT_INITIALIZEDConstantControl not installed'CONTROL_NOT_INITIALIZED'LIKE
SOI_RET_STRING
Public
RET_DOCUMENT_ALREADY_OPENConstantDocument already opened'DOCUMENT_ALREADY_OPEN'LIKE
SOI_RET_STRING
Public
RET_DOCUMENT_NOT_OPENConstantDocument Not Opened'DOCUMENT_NOT_OPEN'LIKE
SOI_RET_STRING
Public
RET_DOCUMENT_NO_VIEW_DATAConstantNo Presentation Data Available'DOCUMENT_NO_VIEW_DATA_AVAILA'LIKE
SOI_RET_STRING
Public
RET_DOC_TYPE_NOT_REGISTEREDConstantNo Editing Program Available'DOCUMENT_TYPE_NOT_REGISTERED'LIKE
SOI_RET_STRING
Public
RET_ERRORConstantErrors'ERROR'LIKE
SOI_RET_STRING
Public
RET_INPLACE_DISABLEDConstantInPlace Display Deactivated'INPLACE_ACTIVATION_DISABLED'LIKE
SOI_RET_STRING
Public
RET_INTERFACE_NOT_SUPPORTEDConstantInterface Not Supported'INTERFACE_NOT_SUPPORTED'LIKE
SOI_RET_STRING
Public
RET_LINK_SERVER_ALREADY_ACTIVEConstantLink Server is Already Running'LINK_SERVER_ALREADY_ACTIVE'LIKE
SOI_RET_STRING
Public
RET_LINK_SERVER_NOT_ACTIVEConstantLink Server is Inactive'LINK_SERVER_NOT_ACTIVE'LIKE
SOI_RET_STRING
Public
RET_MACRO_OR_SCRIPT_FAILEDConstantMacro Execution Failed'MACRO_OR_SCRIPT_FAILED'LIKE
SOI_RET_STRING
Public
RET_MACRO_OR_SCRIPT_NOT_FOUNDConstantMacro Not Found'MACRO_OR_SCRIPT_NOT_FOUND'LIKE
SOI_RET_STRING
Public
RET_METHOD_CANCELLEDConstantCall Terminated by User'METHOD_CANCELLED'LIKE
SOI_RET_STRING
Public
RET_METHOD_NOT_SUPPORTEDConstantMethod Not Supported'METHOD_NOT_SUPPORTED'LIKE
SOI_RET_STRING
Public
RET_NO_LINK_ITEM_SELECTEDConstantNo link item selected'NO_LINK_ITEM_SELECTED'LIKE
SOI_RET_STRING
Public
RET_NO_STANDARD_INTERFACEConstantStandard Interface Not Supported'NO_STANDARD_INTERFACE'LIKE
SOI_RET_STRING
Public
RET_OBJECT_ALREADY_INITIALIZEDConstantObject Already Initialized'OBJECT_ALREADY_INITIALIZED'LIKE
SOI_RET_STRING
Public
RET_OBJECT_NOT_INITIALIZEDConstantObject Not Initialized'OBJECT_NOT_INITIALIZED'LIKE
SOI_RET_STRING
Public
RET_OKConstantOK'OK'LIKE
SOI_RET_STRING
Public
RET_OPEN_DOCUMENT_FAILEDConstantError when opening'OPEN_DOCUMENT_FAILED'LIKE
SOI_RET_STRING
Public
RET_OPEN_DOCUMENT_FILE_FAILEDConstantError when opening'OPEN_DOCUMENT_FILE_FAILED'LIKE
SOI_RET_STRING
Public
RET_SAVE_DOCUMENT_FAILEDConstantError when saving'SAVE_DOCUMENT_FAILED'LIKE
SOI_RET_STRING
Public
RET_SAVE_DOCUMENT_FILE_FAILEDConstantError when saving'SAVE_DOCUMENT_FILE_FAILED'LIKE
SOI_RET_STRING
Public
RET_SYSTEM_ERRORConstantSystem Error'SYSTEM_ERROR'LIKE
SOI_RET_STRING
Public
RET_UNKNOWN_ERRORConstantUnknown error'UNKNOWN_ERROR'LIKE
SOI_RET_STRING
Public




C_OI_ERRORS types

ERROR_ENTRY - ERROR_ENTRY

Links to Related Class(s)

C_OI_ERR...
Full list of available SAP object classes

Search for further information about these or an SAP related objects



Comments on this SAP object

What made you want to lookup this SAP object? Please tell us what you were looking for and anything you would like to be included on this page!