Ets_Ctl_Edit_Selected_Lines_Get()
Note: Requires OPNET Development Kit
Abstract
Gets the lines in the selection range for an edit field or edit area control.
Syntax
Ets_Ctl_Edit_Selected_Lines_Get (ctl_ptr, first_line, last_line)
| Argument | Type | Description |
|---|---|---|
ctl_ptr |
EtsT_Ctl * |
pointer to an ETS control |
first_line |
int * |
pointer to a variable to receive the line number of the start of the selected range of text. This argument must not be NULL. |
last_line |
int * |
pointer to a variable to receive the line number of the end of the selected range of text. This argument must not be NULL. |
Return Type
EtsT_Compcode
EtsC_Compcode_Failure if the control is not an edit field or area; EtsC_Compcode_Success otherwise.
Header
ets_api_gui.h
Details
For edit fields or edit areas, gets the line numbers corresponding to the start and end of the currently selected range of text (inclusive), storing them in the specified variables. If there is no selection range, but only an insertion point, these values will be the same, namely the index of the line containing the insertion point. (Note that these values will always be 0 for edit fields.) For other types of controls, a recoverable error is issued.