Show TOC

TEXT_SYMBOL_PARSELocate this document in the navigation structure

Use

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

The text line to be analyzed is passed in LINE. The parameter START_OFFSET specifies the position of the start symbol & that is required for SAPscript symbols.

The character string is analyzed. If it is a symbol, all information on this symbol is returned in the parameters SYMBOL_...

If it is not a SAPscript symbol, the exception NO_SYMBOL is set.

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

Passes the text line in SAPscript format (structure TLINE), whose contents are to be analyzed with regard to a SAPscript symbol.

Structure: TLINE

START_OFFSET

The offset from where the character string is to be analyzed can be defined with reference to TLINE. The offset must point to the initial escape character & of the potential symbol.

Import parameter:

CONTINUE_OFFSET

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

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

SYMBOL_CONDENSED

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

Possible values:

  • 'X' option set

  • ' ' option not set

SYMBOL_DECIMALS

This parameter returns the decimal point specification entered as an option. If the parameter is empty, this option was not specified for the symbol analyzed.

SYMBOL_DICTLEN

This parameter specifies whether the formatting option * is specified 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 specification entered as an option. If the parameter is empty, this option was not specified for the symbol analyzed. If the option E was specified only without further numbers, the value 0 is returned in this parameter.

SYMBOL_FILLCHAR

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

Possible values:

  • ' ' ' ' No fill character or fill character SPACE

  • Otherwise specified fill character

SYMBOL_LDATE

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

Possible values:

  • 'X' option set

  • ' ' option not set

SYMBOL_LENGTH

This parameter returns the length specification entered as an option. If the parameter is blank, a length was not specified for the analyzed symbol.

SYMBOL_NAME

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

The name is always returned in uppercase letters irrespective of how it is written in the text line.

SYMBOL_NOCONVERT

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

Possible values:

  • 'X' option set

  • ' ' option not set

SYMBOL_NOINIT

This parameter specifies whether the formatting option I (do not output initial value) is set for the analyzed symbol.

Possible values:

  • 'X' option set

  • ' ' option not set

SYMBOL_NOSIGN

This parameter specifies whether the formatting option S (do not output sign) is set for the analyzed symbol.

Possible values:

  • 'X' option set

  • ' ' option not set

SYMBOL_NOZERO

This parameter specifies whether the formatting option Z (omit leading zeros) is set for the analyzed symbol.

Possible values:

  • 'X' option set

  • ' ' option not set

SYMBOL_OFFSET

This parameter returns the offset specification entered as an option. If the parameter is blank, an offset was not specified for the analyzed symbol.

SYMBOL_RIGHT

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

Possible values:

  • 'X' option set

  • ' ' option not set

SYMBOL_SIGNLEFT

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

Possible values:

  • 'X' option set

  • ' ' option not set

SYMBOL_SIGNRIGHT

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

Possible values:

  • 'X' option set

  • ' ' option not set

SYMBOL_TEXT1

This parameter states which preceding text is specified for the analyzed symbol.

The contents of the parameter should be interpreted in conjunction with parameter SYMBOL_TEXT1_LENGTH.

SYMBOL_TEXT1_LENGTH

This parameter specifies the length of the preceding text. The contents of the preceding text are specified in parameter SYMBOL_TEXT1.

If the value is 0, a preceding text is not specified.

SYMBOL_TEXT2

This parameter states which subsequent text is specified for the analyzed symbol.

The contents of the parameter should be interpreted in conjunction with parameter SYMBOL_TEXT2_LENGTH.

SYMBOL_TEXT2_

LENGTH

This parameter specifies the length of the subsequent text. The contents of the subsequent text are specified in the parameter SYMBOL_TEXT2.

If the value is 0, a subsequent text is not specified.

SYMBOL_SEPARATOR_

THOUSAND

The parameter indicates whether the formatting option T was specified. This means that the thousands separator is not output.

Possible values:

  • 'X' option set

  • ' ' option not set

SYMBOL_INCREMENT

The parameter indicates whether the formatting option '+' was specified. This means that the value of the respective counter SAPSCRIPT-COUNTER_x ( x = 0 .. 9) is increased by 1 before output.

Possible values:

  • 'X' option set

  • ' ' option not set

SYMBOL_DECREMENT

The parameter indicates whether the formatting option '-' was specified. This means that the value of the respective counter SAPSCRIPT-COUNTER_x ( x = 0 .. 9) is decreased by 1 before output.

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.

  • etc.