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

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

WordParseGetResult Function

Overview

The WordParseGetResult function returns flags associated with retrieving the last word of a Word Parse Object with the WordParseGetWord function.

Syntax/Parameters

Syntax

dword = WordParseGetResult ( handle hWordParse );

Parameters

hWordParse

A handle to a valid Word Parse Object.

Return Value

Returns a dword containing the bitwise flags associated with the last retrieved word. The possible values are as follows: 

General:
	WP_EOB	0x00010000	End of buffer
	WP_LEADER_BREAK	0x00020000	Stopped for leader or ellipse
	WP_STOP_POSITION	0x00080000	Stop position hit (passed)
	WP_OVERFLOW	0x02000000	Buffer overflow
Tag Mode:
	WP_TAG_BREAK	0x01000000	Word broke on tag syntax
Program Mode:
	WP_PROGRAM_SPACE	0x01000000	Broke on program white space
	WP_PROGRAM_BREAK	0x02000000	Broke on program syntax
	WP_PROGRAM_BREAK_SET	0x04000000	Item is program syntax
	WP_PROGRAM_SYNTAX_ERROR	0x08000000	Program syntax error
	WP_PROGRAM_STRING	0x10000000	Return expression group
	WP_PROGRAM_PARAMETER	0x20000000	Function group ()
	WP_PROGRAM_ARRAY	0x40000000	Array group []
	WP_PROGRAM_FAIL_CLOSE	0x80000000	Failed to close expression

If the buffer has not been specified using the WordParseCreate or WordParseSetData functions, the WordParseGetResult function will return 0. If the hWordParse parameter is invalid, the function will return ERROR_INVALID_HANDLE. Use the GetLastError function to retrieve error information.

Remarks

The WordParseGetResult function will only return flags for the last word as retrieved by the WordParseGetWord function. It is not possible to retrieve the flags associated with any other word in the buffer without first adjusting the position of the WordParseGetWord function with the WordParseSetPosition function.

Related Functions

WordParseCreate — Creates a Word Parse Object with options.

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

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