String class/Get Nth Line method

From LabVIEW Wiki
Jump to: navigation, search
VI Server Method Information
Method ID 6345401
Scope Basic Development Environment
Data Name Get Nth Line
Short Name* Get Nth Line
Long Name* Get Nth Line
* Displayed here in English. Short and Long names appear in the language of the LabVIEW IDE.
Owning Class ID 27
Owning Class Name String Class
Return Data Type No return value
Invoke Node Get Nth Line
Available in Real-Time Operating SystemYes
Available in Run-Time EngineYes (Read/Write)
Loads the block diagram into memoryNo
Loads the front panel into memoryYes
Need to authenticate before useNo
Remote access allowedYes
Settable when the VI is runningYes

Gets the characters that make up the Nth line in a string control and returns the offsets in the original string in bytes.

You can use this method to determine how the text in a string control is word-wrapped. The position indexes are byte indexes. These are usually equivalent to character indexes, except when using text that has characters that use multiple bytes, such as Asian character sets.

Parameters

Data type Name Required Description
U32 line index Yes A number that indicates the line of text in the string control. Line numbers begin at zero.
String line text Yes A substring of the original string indicated by index.
U32 position of line start Yes The byte position in the original string where the substring begins.
U32 position of line end Yes The byte position in the original string where the substring ends.

Uses

History

Version Change(s)
LabVIEW 2018 More info to come.

See Also

External Links