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

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

WordParseSetData Function

Overview

The WordParseSetData function sets a Word Parse Object’s buffer to a string.

Syntax/Parameters

Syntax

int = WordParseSetData ( handle hWordParse, string data );

Parameters

hWordParse

A handle to a valid Word Parse Object.

data

A string that the Word Parse Object can parse.

Return Value

Returns an int as ERROR_NONE on success or ERROR_INVALID_HANDLE if hWordParse is invalid.

Remarks

The WordParseSetData function should be called to set a new string as a Word Parse Object’s buffer. The Word Parse Object must have been previously created with the WordParseCreate function. Setting data as the Word Parse Object’s buffer also sets its parse position to the beginning of the buffer. Note that the method of parsing the buffer cannot be changed once the Word Parse Object has been created.

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.

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.