Start of Content Area

TEXT_SYMBOL_PARSE   Locate the document in its SAP Library structure

This function module analyses whether a character string in SAPscript format within a text line is a SAPscript symbol.

Pass the text line you want to analyze in LINE. The parameter START_OFFSET specifies the position of the start symbol & that is required for SAPscript symbols.

The system analyses the character string. If it is a symbol, it returns all information on this symbol in the parameters SYMBOL_....

If it is no SAPscript symbol, the system returns the exception NO_SYMBOL.

 

Function call:

 

CALL FUNCTION 'TEXT_SYMBOL_PARSE'

EXPORTING LINE = ?...

START_OFFSET = ?...

IMPORTING CONTINUE_OFFSET =

SYMBOL_CONDENSED =

SYMBOL_DECIMALS =

SYMBOL_DICTLEN =

SYMBOL_EXPONENT =

SYMBOL_FILLCHAR =

SYMBOL_LDATE =

SYMBOL_LENGTH =

SYMBOL_NAME =

SYMBOL_NOCONVERT =

SYMBOL_NOINIT =

SYMBOL_NOSIGN =

SYMBOL_NOZERO =

SYMBOL_OFFSET =

SYMBOL_RIGHT =

SYMBOL_SIGNLEFT =

SYMBOL_SIGNRIGHT =

SYMBOL_TEXT1 =

SYMBOL_TEXT1_LENGTH =

SYMBOL_TEXT2 =

SYMBOL_TEXT2_LENGTH =

SYMBOL_SEPARATOR_THOUSAND =

SYMBOL_INCREMENT =

SYMBOL_DECREMENT =

EXCEPTIONS NO_SYMBOL =

 

Export parameters:

LINE

Contains the text line in SAPscript format (structure TLINE), whose contents you want to analyze.

Structure: TLINE

START_OFFSET

Define the offset with reference to TLINE, where the character string to be analyzed starts. The offset must point to the start symbol & of the possible symbol.

 

Import parameters:

CONTINUE_OFFSET

CONTINUE_OFFSET points to the first character after the SAPscript symbol, provided it is a syntactically correct symbol.

If the value is >= 134, the end symbol & of the symbol is positioned at the end of the line.

SYMBOL_CONDENSED

The parameter specifies whether for the analyzed symbol the formatting option C is set (compress blanks).

Possible values:

'X' option set

' ' option not set

SYMBOL_DECIMALS

The parameter returns the number of decimal places set as option. If the parameter is empty, the option was not set for the analyzed symbol.

SYMBOL_DICTLEN

The parameter specifies whether the formatting option * is set for the analyzed symbol (output length according to Dictionary definition).

Possible values:

'X' option set

' ' option not set

SYMBOL_EXPONENT

The parameter returns the exponent specified as option. If the parameter is empty, the option was not set for the analyzed symbol. If only the option E without any further digits was specified, the parameter contains the return value 0.

SYMBOL_FILLCHAR

The parameter specifies whether for the analyzed symbol the formatting option F is set (fill character for leading blanks).

Possible values:

' ' no fill character or fill character SPACE

other specified fill character

SYMBOL_LDATE

The parameter specifies whether for the analyzed symbol the formatting option L is set (local date evaluation).

Possible values:

'X' option set

' ' option not set

SYMBOL_LENGTH

The parameter returns the length set as option. If the parameter is empty, no length was specified for the analyzed symbol.

SYMBOL_NAME

The parameter contains the name of the symbol without escape symbol &.

Independent of the case used in the text line, the system always returns the name in uppercase.

SYMBOL_NOCONVERT

The parameter specifies whether for the analyzed symbol the formatting option K is set (ignore conversion routine from Dictionary).

Possible values:

'X' option set

' ' option not set

SYMBOL_NOINIT

The parameter specifies whether for the analyzed symbol the formatting option I is set (suppress initial value).

Possible values:

'X' option set

' ' option not set

SYMBOL_NOSIGN

The parameter specifies whether for the analyzed symbol the formatting option S is set (suppress sign).

Possible values:

'X' option set

' ' option not set

SYMBOL_NOZERO

The parameter specifies whether for the analyzed symbol the formatting option Z is set (suppress leading zeroes).

Possible values:

'X' option set

' ' option not set

SYMBOL_OFFSET

The parameter returns the offset set as option. If the parameter is empty, no offset was specified for the analyzed symbol.

SYMBOL_RIGHT

The parameter specifies whether for the analyzed symbol the formatting option R is set (output right-justified).

Possible values:

'X' option set

' ' option not set

SYMBOL_SIGNLEFT

The parameter specifies whether for the analyzed symbol the formatting option < is set (sign on the left).

Possible values:

'X' option set

' ' option not set

SYMBOL_SIGNRIGHT

The parameter specifies whether for the analyzed symbol the formatting option > is set (sign on the right).

Possible values:

'X' option set

' ' option not set

SYMBOL_TEXT1

The parameter specifies which prefix text is specified for the analyzed symbol.

You must interpret the contents of the parameter in connection with the parameter SYMBOL_TEXT1_LENGTH.

SYMBOL_TEXT1_LENGTH

The parameter specifies the length of the prefix text. The contents is specified in the parameter SYMBOL_TEXT1.

If the value is 0, no prefix text is specified.

SYMBOL_TEXT2

The parameter specifies which suffix text is specified for the analyzed symbol.
You must interpret the contents of the parameter in connection with the parameter SYMBOL_TEXT2_LENGTH.

SYMBOL_TEXT2_LENGTH

The parameter specifies the length of the suffix text. The contents is specified in the parameter SYMBOL_TEXT2.

If the value is 0, no suffix text is specified.

SYMBOL_SEPARATOR_ THOUSAND

The parameter specifies whether for the analyzed symbol the formatting option T is set (no separator between thousands).

Possible values:

'X' option set

' ' option not set

SYMBOL_INCREMENT

The parameter specifies whether for the analyzed symbol the formatting option '+' is set. This means that before outputting the value the system increases the value of the corresponding counter SAPSCRIPT-COUNTER_x ( x = 0.. 9) by 1.

Possible values:

'X' option set

' ' option not set

SYMBOL_DECREMENT

The parameter specifies whether for the analyzed symbol the formatting option '-' is set. This means that before outputting the value the system decreases the value of the corresponding counter SAPSCRIPT-COUNTER_x ( x = 0.. 9) by 1.

Possible values:

'X' option set

' ' option not set

 

Exceptions:

NO_SYMBOL

The character string that starts at the specified position is not a symbol of the SAPscript syntax.

Possible errors:

  • The symbol was not closed by the character &.
  • The name of the symbol contains blanks.
  • The symbol extends over the end of a SAPscript editor line.
  • Additional formatting options are not enclosed in parentheses.
  • The key letters of the formatting options are not written in uppercase.
  • An invalid formatting option was entered.
  • The offset specification does not follow the symbol name directly.
  • Previous and/or subsequent texts are not enclosed in inverted commas.