START SAP Method Call ABAP Keyword Documentation
Below is documentation, parameters and attributes of ABAP Method START within SAP class CL_ABAP_DOCU. There is also a number of example ABAP code snipts to help you use the functionality of this method.
This method is available within SAP systems depending on your version and release level, you can view further information by entering the class name CL_ABAP_DOCU into the relevant SAP transactions such as SE24 or SE80, and then selecting the method you are interested in.
Method Type - Static
This is a Static Method so you can call it directlyThe following technical details of method START can also be found below:
- Importing parameters
- Exporting parameters
- Changing parameters
- Returning parameters
- Exceptions
- Coding Examples
Parameters of Method START
.| Name | Type | Data Type | Description | Default Value |
| DEBUG_FLAG | Importing | TYPE ABAP_BOOL | Special Display Mode for Calls from ABAP Debugger | |
| EXAMPLES_FLAG | Importing | TYPE ABAP_BOOL | Searching in Examples | |
| FIRST_WORD | Importing | TYPE CSEQUENCE | First Word of Statement | |
| FULL_TEXT_FLAG | Importing | TYPE ABAP_BOOL | Full Text Search | |
| GLOSSARY_FLAG | Importing | TYPE ABAP_BOOL | Search in Glossary | |
| INDEX_FLAG | Importing | TYPE ABAP_BOOL | Search in Index | |
| LANGU | Importing | TYPE SY-LANGU | Language for Full Text Search | |
| MODE | Importing | TYPE CSEQUENCE | 'ABAP' or 'DYNP' | |
| NO_DIALOG | Importing | TYPE ABAP_BOOL | Return of Results Without Display | |
| NO_SIMILARS | Importing | TYPE ABAP_BOOL | No Similarity Search | |
| SUBJECTS_FLAG | Importing | TYPE ABAP_BOOL | Search in Keywords | |
| TOKENS | Importing | TYPE ABAPDOCU_TOKENS | All Tokens of Statement | |
| WORD | Importing | TYPE CSEQUENCE | ABAP Term (Generic if Necessary) | |
| BDL_F1_CONTEXT | Importing | TYPE CL_ABAP_DOCU_EXTERNAL=>BDL_F1_CONTEXT | ||
| CDS_F1_CONTEXT | Importing | TYPE CL_ABAP_DOCU_EXTERNAL=>CDS_F1_CONTEXT | ||
| MODE | Importing | TYPE CL_ABAP_DOCU=>MODE | 'ABAP', DYNP', 'CDS' etc. | |
| SUBJECTS_FLAG | Importing | TYPE ABAP_BOOL | Search in Catchwords | |
| SUBTREE | Importing | TYPE CSEQUENCE | Subtree | |
| VERSION | Importing | TYPE CL_ABAP_DOCU=>VERSION | ABAP Language Version | |
| WORD | Importing | TYPE CSEQUENCE | ABAP Term (possibly Generic) | |
| DOCU_CONTAINER | Exporting | TYPE REF TO CL_GUI_CONTROL | Reference to Docomentation or Hit List Container | |
| SEARCH_RESULTS | Exporting | TYPE CL_ABAP_DOCU=>SEARCH_RESULTS | Search Result if NO_DIALOG = 'X' | |
| STRUCTURED_SEARCH_RESULTS | Exporting | TYPE CL_ABAP_DOCU=>SEARCH_RESULTS | ||
| SEARCH_RESULTS | Exporting | TYPE CL_ABAP_DOCU=>SEARCH_RESULTS | Search Result, if NO_DIALOG = 'X' | |
| STRUCTURED_SEARCH_RESULTS | Exporting | TYPE CL_ABAP_DOCU=>SEARCH_RESULTS |
Exceptions of Method START
This method does not have any exceptionsExample ABAP coding
DATA: lv_DEBUG_FLAG TYPE ABAP_BOOL,
lv_DOCU_CONTAINER TYPE CL_GUI_CONTROL,
lv_EXAMPLES_FLAG TYPE ABAP_BOOL,
lv_FIRST_WORD TYPE CSEQUENCE,
lv_FULL_TEXT_FLAG TYPE ABAP_BOOL,
lv_GLOSSARY_FLAG TYPE ABAP_BOOL,
lv_INDEX_FLAG TYPE ABAP_BOOL,
lv_LANGU TYPE SY-LANGU,
lv_MODE TYPE CSEQUENCE,
lv_NO_DIALOG TYPE ABAP_BOOL,
lv_NO_SIMILARS TYPE ABAP_BOOL,
lv_SEARCH_RESULTS TYPE CL_ABAP_DOCU=>SEARCH_RESULTS,
lv_STRUCTURED_SEARCH_RESULTS TYPE CL_ABAP_DOCU=>SEARCH_RESULTS,
lv_SUBJECTS_FLAG TYPE ABAP_BOOL,
lv_TOKENS TYPE ABAPDOCU_TOKENS,
lv_WORD TYPE CSEQUENCE,
lv_BDL_F1_CONTEXT TYPE CL_ABAP_DOCU_EXTERNAL=>BDL_F1_CONTEXT,
lv_CDS_F1_CONTEXT TYPE CL_ABAP_DOCU_EXTERNAL=>CDS_F1_CONTEXT,
lv_MODE TYPE CL_ABAP_DOCU=>MODE,
lv_SEARCH_RESULTS TYPE CL_ABAP_DOCU=>SEARCH_RESULTS,
lv_STRUCTURED_SEARCH_RESULTS TYPE CL_ABAP_DOCU=>SEARCH_RESULTS,
lv_SUBJECTS_FLAG TYPE ABAP_BOOL,
lv_SUBTREE TYPE CSEQUENCE,
lv_VERSION TYPE CL_ABAP_DOCU=>VERSION,
lv_WORD TYPE CSEQUENCE,
lv_other TYPE c.
CALL METHOD CL_ABAP_DOCU=>START(
EXPORTING
DEBUG_FLAG = lv_DEBUG_FLAG
EXAMPLES_FLAG = lv_EXAMPLES_FLAG
FIRST_WORD = lv_FIRST_WORD
FULL_TEXT_FLAG = lv_FULL_TEXT_FLAG
GLOSSARY_FLAG = lv_GLOSSARY_FLAG
INDEX_FLAG = lv_INDEX_FLAG
LANGU = lv_LANGU
MODE = lv_MODE
NO_DIALOG = lv_NO_DIALOG
NO_SIMILARS = lv_NO_SIMILARS
SUBJECTS_FLAG = lv_SUBJECTS_FLAG
TOKENS = lv_TOKENS
WORD = lv_WORD
BDL_F1_CONTEXT = lv_BDL_F1_CONTEXT
CDS_F1_CONTEXT = lv_CDS_F1_CONTEXT
MODE = lv_MODE
SUBJECTS_FLAG = lv_SUBJECTS_FLAG
SUBTREE = lv_SUBTREE
VERSION = lv_VERSION
WORD = lv_WORD
IMPORTING
DOCU_CONTAINER = lv_DOCU_CONTAINER
SEARCH_RESULTS = lv_SEARCH_RESULTS
STRUCTURED_SEARCH_RESULTS = lv_STRUCTURED_SEARCH_RESULTS
SEARCH_RESULTS = lv_SEARCH_RESULTS
STRUCTURED_SEARCH_RESULTS = lv_STRUCTURED_SEARCH_RESULTS ).
Links to Related Class(s)
CL_ABAP_...Full list of available SAP object classes
Search for further information about these or an SAP related objects