GoFiler Legato Script Reference   Legato v 1.4j Application v 5.22b

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

WordParseGetStartX Function

Overview

The WordParseGetStartX function returns the zero-based start character position of the last word retrieved from a Word Parse Object with the WordParseGetWord function.

Syntax/Parameters

Syntax

int = WordParseGetStartX ( handle hWordParse );

Parameters

hWordParse

A handle to a valid Word Parse Object.

Return Value

Returns an int containig the zero-based start character position of the last retrieved word or -1 if the buffer has not been specified using the WordParseCreate or WordParseSetData functions. If the hWordParse parameter is invalid, the function will return ERROR_INVALID_HANDLE. Use the GetLastError function to retrieve error information.

Remarks

The WordParseGetEndX function will only return a valid starting character position for the last word as retrieved by the WordParseGetWord function. It is not possible to retrieve the position of any other word in the buffer without first adjusting the position for the WordParseGetWord function with the WordParseSetPosition function.

This function differs from WordParseGetPosition in that WordParseGetStartX and WordParseGetPosition get the next position (essentially the end of the last item parsed).

Related Functions

WordParseCreate — Creates a Word Parse Object with options.

WordParseGetPosition — Gets the position of the zero-based X last parsed word.

WordParseGetResult — Returns flags from last word parsed.

WordParseGetSpace — Gets the leading space string from the last word parsed.

WordParseGetSpaceSize — Gets leading space as count from the last word parsed.

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

WordParseHasSpace — Tests for leading space while parsing the last word.

WordParseSetData — Sets a buffer (line, etc) into a parse object.

WordParseSetPosition — Sets the zero-based X position for the next parse action.

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 04/22/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.