Admin Production ni-theme
Current Publication

ReplaceTextBoxLine

LabWindows/CVI

ReplaceTextBoxLine

int ReplaceTextBoxLine (int panelHandle, int controlID, int lineIndex, char text[]);

Purpose

Replaces a specific text box line with the string you specify.

Note  If you are replacing the last line of the text box, and the existing text is not followed by a newline character, this function inserts a newline character following the new text.

Supported Controls

You can use ReplaceTextBoxLine 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.
text char [] String to replace the line of text at the 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