  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Five — General Functions (continued)
Overview
The SkipToLineEnding function scans a string forwards from a specified position until either a line ending is found or the end of the string is reached.
Syntax/Parameters
Syntax
int = SkipToLineEnding ( string data, int index );
Parameters
data
A string.
index
An int containing the zero-based starting index position.
Return Value
Returns an int containing the zero-based index of the first line ending character encountered from position index or -1 on failure. Use the GetLastError function to retrieve error information.
Remarks
The SkipToLineEnding function (and other skip functions) can be used to manually parse or scan a string for information. Line ending are counted as return (0x0D/13) and newline (0x0A/10).
If the index parameter contains a negative number or a position beyond the length of the string, the GetLastError function will return ERROR_RANGE. If a line ending cannot be found, the GetLastError function will return ERROR_EOD.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| Table of Contents | < < Previous | Next >> |
© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.