GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

WordParseSetPosition Function

Overview

The WordParseSetPosition function sets the zero-based starting character position for the next word retrieved from a Word Parse Object with the WordParseGetWord function.

Syntax/Parameters

Syntax

int = WordParseSetPosition ( handle hWordParse, int position );

Parameters

hWordParse

A handle to a valid Word Parse Object.

position

An int specifying a zero-based character position within a string.

Return Value

Returns an int as ERROR_NONE on success, ERROR_RANGE if position is beyond the length of the buffer, or ERROR_INVALID_HANDLE if hWordParse is invalid.

Remarks

The WordParseSetPosition function moves the parsing position to the character position specified by the position parameter. This affects the next word returned by the WordParseGetWord function, as well as of the information and flags associated with that word.

If the position parameter falls within a word, the beginning of the return word will be at the position specified.

If the position parameter falls within a leading space, the function moves to the beginning of the next word on the next parse action. The leading space value will reflect the point of the start of the parse action.

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.

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 10/21/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.