Admin Production ni-theme
Current Publication

GetTextBoxLineLength

LabWindows/CVI

GetTextBoxLineLength

int GetTextBoxLineLength (int panelHandle, int controlID, int lineIndex, int *length);

Purpose

Returns the number of bytes in a specific text box line, including ASCII NUL characters.

Supported Controls

You can use GetTextBoxLineLength 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.
Output
Name Type Description
length int The number of bytes in the text box line. The length does not include the terminating NUL byte.

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