Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter FiveGeneral Functions (continued)

SkipToNonText Function

Overview

The SkipToNonText function scans a string forwards from a specified position until either a non-alphanumeric character is found or the end of the string is reached.

Syntax/Parameters

Syntax

int = SkipToNonText ( 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 non-alphanumeric character encountered from position index or -1 on failure. Use the GetLastError function to retrieve error information.

Remarks

The SkipToNonText function (and other skip functions) can be used to manually parse or scan a string for information.

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 non-alphanumeric character 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