Ets_Ctl_Edit_Selection_Get()
Note: Requires OPNET Development Kit
Abstract
Gets the selected text from an edit area or edit field control.
Syntax
Ets_Ctl_Edit_Selection_Get (ctl_ptr, text_lptr)
| Argument | Type | Description |
|---|---|---|
ctl_ptr |
EtsT_Ctl * |
pointer to an ETS control |
text_lptr |
PrgT_List * |
pointer to a list into which the selected text is written |
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, copies the selected range of text into the specified text list, which must have been previously allocated by the caller. The previous contents of this list are lost. The new contents of the list are the selected text, broken into list elements where the line breaks occurred in the control. For other types of controls, a recoverable error is issued.