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

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

WordParseGetWord Function

Overview

The WordParseGetWord function retrieves the next word from a Word Parse Object.

Syntax/Parameters

Syntax

string = WordParseGetWord ( handle hWordParse );

Parameters

hWordParse

A handle to a valid Word Parse Object.

Return Value

Returns a string containing the next word from a Word Parse Object or an empty string if the buffer has not been specified using the WordParseCreate or WordParseSetData functions. Use the GetLastError function to retrieve error information.

Remarks

When the WordParseGetWord function is called, it will “move” the Word Parse Object’s position to the next word depending on the mode specified when the object was created with the WordParseCreate function. The next word will be returned, and any number and combination of white or word spaces preceding that word will be stored as well as flags produced by processing that word. These data can be accessed by other Word Parse functions. The next call to the WordParseGetWord function advances the position to the next word, returning it and storing its flags and leading spaces, and so on. The WordParse buffer can be parsed and “walked through” by calling the WordParseGetWord function in a loop until the NW_EOB flag is returned, signaling the end of the buffer.

To move the position of the WordParseGetWord function to a specified point, use the WordParseSetPosition function.

If the hWordParse parameter is invalid, the GetLastError function will return ERROR_INVALID_HANDLE.

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.

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