InsertTextBoxLine
int InsertTextBoxLine (int panelHandle, int controlID, int lineIndex, char text[]);
Purpose
Inserts a string as a new line in a text box.
 |
Note The function inserts a newline character at the end of the text that you specify. |
Supported Controls
You can use InsertTextBoxLine 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 of the text box line above which to insert the string. Pass –1 to insert the new string at the end of the text box. |
| text | char [] | Text to insert at the specified lineIndex. |
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
Examples
Refer to the following examples that use the InsertTextBoxLine function:
- toolbox\msgdemo.cws
Open example - userint\docking.cws
Open example - userint\textbox.cws
Open example