Fonction SAP BAPI_HYPERLINK_GETTEXT - Read Hypertext Links of Documentation

Paramètre	Reférence	Type	Long.	Valeur par déf.	Facultatif	Description
BACKLINK	BAPITGA-HTML_BACK	C	1	' '	X	Insert a "Back" Link (HTML only)
LANGUAGE	BAPITGA-LANGU	C	1	SY-LANGU	X	Language of text to be displayed
LINKPATTERN	BAPITGA-LINKMASK	C	255	' '	X	Convert SAPscript Hyperlinks to HTML
LINKSTRING	BAPITGA-LINKSTRING	C	255			Link to Expand
TEXTFORMAT	BAPITGA-TEXTFORMAT	C	3	'HTM'	X	Format of Text to be Displayed

Paramètre	Reférence	Type	Long.	Description
RETURN	BAPIRET2	u	548	Return Messages
SHORTTEXT	BAPITGA-SHORTTEXT	C	80	Short Text of Referenced Object

Paramètre	Reférence	Long.	Facultatif	Description
TEXT	BAPITGB	255		Table for the Text

Functionality
This method reads the documentation for an R/3 object that is linked toin a document and that was created with the methodBapiService.InterfaceGetDocu or the methodBapiService.HyperLinkGetText.
In the parameterLinkPattern you canconvert the SAPscript hyperlinks into HTML hyperlinks.

Description
Error messages concerning 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 Text display format <(>&<)> is not supported
E S<(>&<)>104 Document does not exist
E S<(>&<)>105 Error reading the document
W S<(>&<)>114 Parameter <(>&<)> can only be set for text
format HTM.

Description
Contains the short text of the object that is referenced with theparameter LinkStringprovided that this parameter exists.
Otherwise the parameter is set to initial.

Description
If this parameter is set, the hyperlink "Back" in inserted into thegenerated text which takes the user to the document last displayed inthe HTML display.
The parameter can only be set when thetext format HTM isused, otherwise the returnparameter is filled with a warning and the parameter is ignored.

Description
Language in which the documentation is to be displayed in.

Default
If this parameter is empty, the logon language is used.

Description
Specifies how SAPscript hyperlinks are to be converted. They can onlybe converted into thetext format HTM,otherwise the returnparameter issues a warning and the hyperlinks are displayed as text.
If the parameter is set to initial, hyperlinks are converted to normaltext.
The description of the syntax for the conversion can be found in thedocumentation for the data element.

Description
Contains the SAPscript hyperlink, whose long text is to be requested.
The link must have the following syntax:
xxxx.yyyyyyyyyy
where xxxx the 2 to 4 character document class and yyyyyyyyyy is thename of the documentation object, for example, 'DE.BAPI_LMASK'.
The value of this parameter is used as variable &1 in the parameterLinkPattern whenthe hyperlinks are converted.

Description
Display format of documentation.

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

Default
The standard is HTM and the links can only be maintained in thisformat.

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