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

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

WordParseHasSpace Function

Overview

The WordParseHasSpace function tests if the last word retrieved from a Word Parse Object with the WordParseGetWord function has a leading space.

Syntax/Parameters

Syntax

boolean = WordParseHasSpace ( handle hWordParse );

Parameters

hWordParse

A handle to a valid Word Parse Object.

Return Value

Returns a boolean value as TRUE if the last word retrieved by the WordParseGetWord function has leading spaces or FALSE if it does not. Use the GetLastError function to retrieve error information.

Remarks

The WordParseHasSpace function will consider any number and combination of white or word spaces up to 256 characters as the leading space. The function will only test the last word as retrieved by the WordParseGetWord function for a leading spaces. It is not possible to test any other word in the buffer for leading spaces without first adjusting the position of the WordParseGetWord function with the WordParseSetPosition function.

Because the WordParseHasSpace function will also return FALSE if the Word Parse Object’s buffer has not been specified using the WordParseCreate or WordParseSetData functions, the value of the GetLastError function should be checked. 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.

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

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.