Admin Production ni-theme
Current Publication

DeleteTextBoxLines

LabWindows/CVI

DeleteTextBoxLines

int DeleteTextBoxLines (int panelHandle, int controlID, int lineIndex, int numberOfLines);

Purpose

Deletes one or more lines from a text box starting at the specified zero-based index.

Supported Controls

You can use DeleteTextBoxLines 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.
numberOfLines int The number of lines to delete.

To delete all lines from lineIndex to the end, pass –1.

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 5.5 and later