GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

SkipToWordSpace Function

Overview

The SkipToWordSpace function scans a string forwards from a specified position until either a word space character is found or the end of the string is reached. 

Syntax/Parameters

Syntax

int = SkipToWordSpace ( string data, [int index] );

Parameters

data

A string.

index

An int containing the zero-based starting index position. If omitted, the function starts at 0.

Return Value

Returns an int containing the zero-based index of the first word space character encountered forwards from position index or -1 on failure. Use the GetLastError function to retrieve error information.

Remarks

The SkipToWordSpace function (and other skip functions) can be used to manually parse or scan a string for information. Word spaces are counted as spaces (0x20/32), carriage returns (0x0D/13), newlines (0x0A/10), tabs (0x09/9), tab placeholders/backspaces (0x08/8), and form feeds (0x0C/12).

If the index parameter contains a negative number, the GetLastError function will return ERROR_RANGE. If a word space character cannot be found, the GetLastError function will return ERROR_EOD.

Related Functions

SkipBackWordSpaces — Skips back from a specified index to the first non-word space character.

SkipToLineEnding — Skips forward to the next line ending character (0x0D/0x0A).

SkipToNonText — Skips forward to a character that is not alpha-numeric.

SkipWordSpaces — Skips forward until not on a word space.

WordParseGetWord — Parsed the next item or word and returns a string.

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/2024

© 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.