sapgui_text_edit_get_selection_index_start

Text Edit Control Functions

Gets the start position of the selected text.

int sapgui_text_edit_get_selection_index_start( 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
argsOptional Arguments
LAST A marker indicating the end of the argument list. Not required if Optional Arguments are used.

sapgui_text_edit_get_selection_index_start assigns the zero based character index of the start of the selected range to parameter outParamName.

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_selection_index_start assigns the offset of the first character in the selection to parameter "startPos."

sapgui_text_edit_get_selection_index_start(
    "Get first",
    "usr/cntlSRC/shellcont/shell",
    "startPos",
    LAST );