DeleteTextBoxLine
int DeleteTextBoxLine (int panelHandle, int controlID, int lineIndex);
Purpose
Removes a line of text from a text box control at the specified index.
 |
Note The function removes the newline character that terminates the line at the specified index, if one exists. |
Supported Controls
You can use DeleteTextBoxLine with text box controls.
Parameters
| Input | ||
| Name | Type | Description |
| panelHandle | int | Specifier for a particular panel that is currently in memory. You can obtain this handle from functions such as LoadPanel and NewPanel. |
| controlID | int | The defined constant, located in the .uir header file, that you assigned to the control in the User Interface Editor, or the ID returned by functions such as NewCtrl and DuplicateCtrl. |
| lineIndex | int | Zero-based index into the text box. |
Return Value
| Name | Type | Description |
| status | int | Return value indicating whether the function was successful. A negative number indicates that an error occurred. |
Additional Information
Library: User Interface Library
Include file: userint.h
LabWindows/CVI compatibility: LabWindows/CVI 3.0 and later
Example
Refer to userint\textbox.cws for an example of using the DeleteTextBoxLine function.