Functionality
This method reads the documentation (F1 help) for the fields in a BAPIparameter.
With this parameter you can provide end users with information on aspecific field in a BAPI parameter. For example, you can help them toenter a correct value in an input field.
One function of this method's parameters is to identify the field forwhich the documentation is to be displayed. They delimit the businessobject, method and parameter containing the field in question andspecify the field.

Example
In this example the F1 help for the field "National" in the parameter"PersonalData" of the BAPI "Employee.GetList" is to be displayed in RTFformat and in English.
Import Parameter,,Value
OBJTYPE
OBJNAME,,,,,,,,"Employee"
METHOD,,,,,,,,"GetList"
PARAMETER,,,,,,"PersonalData"
FIELD,,,,,,,,"National"
LANGUAGE,,,,,,"EN"
TEXTFORMAT,,,,,,"RTF"

Notes
Messages are returned in the parameter RETURN. The documentation onthis parameter contains the return codes and their descriptions.
Use this method together with the method HelpValues.GetList. You willfind details of this method in its documentation.

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 available.
E S&103 Text display format <(>&<)> is not supported.
E S&104 Document does not exist.
E S&105 Error reading the document.
E S&106 Please enter only one of the parameters OBJTYPE or OBJNAME.
E S&107 Parameter PARAMETER is specified, but not the
parameter METHOD
E S&108 Parameter FIELD is specified but not the ParameterPARAMETER.
E S&109 Object does not exist.
E S&110 Object method does not exist.
E S&111 Method parameter does not exist.
E S&112 Parameter field does not exist.
E S&113 Parameter OBJTYPE and OBJNAME describe different objects.
W S&114 Parameter LINKPATTERN can only be set for text format HTM.

Description
Name of the field in the method parameter, for which documentation isto be displayed.
To find a field name you have to find the reference structure of theparameter in the Business Object Repository. In the ABAP Dictionary youcan display details of individual parameter fields by specifying thereference structure.
If the method parameter containing the field in question does notconsist of a structure or a table (it's actually a field), then youmust:

• Specify the name of the field in the parameter PARAMETER of the method
FieldhelpGetDocu.

• Set the parameter FIELD of the method FieldhelpGetDocu to BLANK.

Description
The 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 be convertedonly in the text formatHTM. If they are not, a warning is issued in thereturn parameter and thehyperlinks are displayed as text.
If the parameter is initial, hyperlinks are converted to normal text.
A description of the syntax for the conversion can be found in thedocumentation for the data element.

Description
Name of the method of the business object, for example "GetList",containing the parameter and the field for which the documentation isto be displayed.

Description
The name of the oject 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.
Keep in mind that the object name is case-sensitive and enter the nameexactly as it appears in the BOR.
To identify the business object, either the object name must bespecified in the parameter OBJNAME or the object type ID must bespecified in the parameter OBJTYPE must be specified when the method iscalled.
For further information about the meaning of the object name see therelevant data element documentation: 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, either the object type ID must bespecified in the parameter OBJTYPE or the object name must be specifiedin the parameter OBJNAME, when the method is called.
For more information about the meaning of the object type see therelevant data element documentation: Object Type

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

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


• Enter the name of the field in the parameter PARAMETER of the method
FieldhelpGetDocu.

• Set the parameter FIELD of the method FieldhelpGetDocu 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 long.