Functionality
This method reads the interface documentation for a BAPI.
The method enables you to read out and make available to developers theinformation they need to implement BAPIs correctly.
The parameters of this method delimit the documentation to bedisplayed. With these parameters you can specify whether you want todisplay the documentation on a business object, method, parameter orfield. The BAPI interface documentation below can be accessed with thismethod:

• The documentation on the business object, if one of the two parameters
OBJTYPE or OBJNAME contains a value and the parameters METHOD,PARAMETER and FIELD are BLANK.

• The documentation on the method, if one of the two parameters OBJTYPE
or OBJNAME contains a value and the method name is specified in theparameter METHOD. The parameters PARAMETER and FIELD must also beBLANK.

• The docmentation on the parameter, if the parameter name is also
transferred in the field PARAMETER.

• The field name, if the field name is also transferred in the parameter
FIELD. This is only possible, if a structure has been used for theparameter.

Example
In this example the documentaion on the BAPI "Employee.GetList" isretrieved without the parameter documentation. It is displayed inEnglish (EN) in RTF text format.
Import Parameter,,Value
OBJTYPE
OBJNAME,,,,,,,,"Employee"
METHOD,,,,,,,,"GetList"
PARAMETER
FIELD
LANGUAGE,,,,,,"EN"
TEXTFORMAT,,,,,,"RTF"

Notes
Messages are returned in the parameter RETURN. This parameterdocumentation contains the return codes and their descriptions.

Description
Error Messages for the method

Value range
If an error occurs, the following messages are returned:
Type Code Message
E S&101 Language <(>&<)> is not supported
E S&103 Display format <(>&<)> for text is not supported
E S&104 Document does not exist
E S&105 Error has occurred when reading the document
E S&106 Please specify only one of the parameters OBJTYPE or
OBJNAME
E S&107 Parameter PARAMETER specified but not parameter METHOD
E S&108 Parameter FIELD specified but not parameter PARAMETER
E S&109 Object does not exist
E S&110 Object method does not exist
E S&111 Method parameter deos not exist
E S&112 Parameter field does not exist
E S&113 Parameters OBJTYPE and OBJNAME describe different objects
W S<(>&<)>114 Parameter LINKPATTERN can only be set for
text format HTM

Description
Name of the parameter field, for which the interface documentation isto be displayed.
To find out the field name, ascertain the reference structure of theparameter in the Business Object Repository.
With the reference structure you can display details of the individualparameter fields in the ABAP Dictionary. If the method parametercontaining the field in question does not consist of a structure or atable (it's actually a field):


• The field name must be specified in the paramteter PARAMETER of the
method InterfaceGetDocu.

• The parameter FIELD of the method InterfaceGetDocu must be set to
BLANK.

Description
Language in which the documentation is displayed.
If this parameter does not contain a value, the logon language is used.

Description
Specifies how SAPscript hyperlinks are converted. They can only beconverted into the textformat HTM, otherwise thereturn parameter issuesa warning and the hyperlinks are displayed as normal text.
If the parameter is set to initial, hyperlinks are converted to normaltext.
A description of the syntax for the conversion can be found in thedocumentation on the data element.

Description
Name of the business object method, for example, "GetList", for whichinterface documentation is to be displayed.

Description
The name of the object type in the Business Object Repository. The nameof the object type is the business description of the object type. Thisname, like the object type ID, is unique.
Remember that the object name is case-sensitive and enter the nameexactly as it appears in the BOR.
To identify the business object, when the method is called, either theobject name must be specified in the parameter OBJNAME or the objecttype ID must be specified in the parameter OBJTYPE.
For further information about the object name see the data elementdocumentation: Object Name

Example
An example of an object name is "Employee" with its associated objecttype "BUS1065".

Description
The identification (ID) of the object type. This is the technical keyof the object type in the Business Object Repository.
To identify the business object, when the method is called, either the
object type ID must be specified in the parameter
OBJTYPE, or the object name must be specified in the parameter OBJNAME.
For further information on the description of the object type see thedata element documentation: Object Type

Example
An example of an object type is "BUS1065" with its associated objectname "Employee".

Description
Name of the method parameter, for example "PersonalData", for whichdocumentation is to be displayed.
If this parameter does not consist of a structure or a table (it'sactually a field), then:


• The name of the field must be specified in the parameter PARAMETER of
the method InterfaceGetDocu

• The parameter FIELD of the method InterfaceGetDocu must be set to BLANK

Description
Display format of documentation.

Value range
Possible formats:
HTM (Hypertext Markup Language)
RTF (Rich Text Format)
SCR (SAPscript)
ASC (ASCII)

Description
This parameter contains the documentation in the format specified.
Each line can be a maximum of 255 bytes.