sapgui_text_edit_get_first_visible_line

Text Edit Control Functions

Gets the number of the first line.

int sapgui_text_edit_get_first_visible_line( const char *description, const char *textEditID, const char *outParamName, [args,] LAST );
description User entered text to aid in understanding script
textEditIDObject ID Strings
outParamName The name of the parameter in which to store the retrieved value
FileName The full path name of the file to be dropped
argsOptional Arguments
LAST A marker indicating the end of the argument list. Not required if Optional Arguments are used.

sapgui_text_edit_get_first_visible_line assigns the number of the first line visible at the top border of the control to outParamName. The lines are numbered from one.

Return Values

This function returns LR_PASS (0) on success or LR_FAIL (1) on failure.

Parameterization

You can parameterize all string (char type) arguments.

Example

In this example, sapgui_text_edit_get_first_visible_line assigns the number of the first visible line to parameter "pFirstVisibleLine."

sapgui_text_edit_get_first_visible_line(
    "First line of edit control",
    "usr/cntlSRC/shellcont/shell",
    "pFirstVisibleLine",
    LAST );