|
GoFiler Legato Script Reference
Legato v 1.6l
Application v 6.6b
|
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
defined below in Remarks.
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.
The primary bits define the top level type or response:
| |
Definition |
|
Bitwise |
|
Description |
|
| |
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 |
|
For program parse mode, the following additional detail bits are supplied:
|
|
|
|
|
|
|
|
| |
Definition |
|
Bitwise |
|
Description |
|
| |
Control: |
|
|
|
|
|
| |
|
WP_RESULT_MASK |
|
0x0000FFFF |
|
Parse Result Mask |
|
| |
|
WP_RESULT_GROUP_MASK |
|
0x0000FF00 |
|
Parse Result Mask |
|
| |
|
WP_RESULT_CALLER_MASK |
|
0xFFFF0000 |
|
Reserved (Caller Bits/Space) |
|
| |
Strings (literal): |
|
|
|
|
|
| |
|
NW_RESULT_STRING |
|
0x00000000 |
|
Normal Narrow String (default " / ') |
|
| |
|
NW_RESULT_STRING_L |
|
0x00000001 |
|
Wide String L" |
|
| |
|
NW_RESULT_STRING_R |
|
0x00000002 |
|
Raw String (8-bit) R" |
|
| |
Comments: |
|
|
|
|
|
| |
|
WP_RESULT_COMMENT |
|
0x00000100 |
|
Comment Group |
|
| |
|
WP_RESULT_COMMENT_EOL |
|
0x00000101 |
|
Comment to EOL / / |
|
| |
|
WP_RESULT_COMMENT_OPEN |
|
0x00000102 |
|
Comment to Open / * |
|
| |
|
WP_RESULT_COMMENT_CLOSE |
|
0x00000103 |
|
Comment to Close * / |
|
| |
Control: |
|
|
|
|
|
| |
|
WP_RESULT_CONTROL |
|
0x00000200 |
|
Control Group |
|
| |
|
WP_RESULT_END |
|
0x00000201 |
|
Expression End ; |
|
| |
|
WP_RESULT_NEXT |
|
0x00000202 |
|
Next Item/Parameter , |
|
| |
|
WP_RESULT_BLOCK_OPEN |
|
0x00000203 |
|
Block/Group Open { |
|
| |
|
WP_RESULT_BLOCK_CLOSE |
|
0x00000204 |
|
Block/Group Close } |
|
| |
|
WP_RESULT_LABEL |
|
0x00000205 |
|
Label / ID : |
|
| |
Logical Operators: |
|
|
|
|
|
| |
|
WP_RESULT_LOGICAL_OPERATOR |
|
0x00000300 |
|
Logical Group |
|
| |
|
WP_RESULT_LOGICAL_NOT |
|
0x00000301 |
|
Logical NOT ! |
|
| |
|
WP_RESULT_LOGICAL_AND |
|
0x00000302 |
|
Logical AND && |
|
| |
|
WP_RESULT_LOGICAL_OR |
|
0x00000303 |
|
Logical OR || |
|
| |
|
WP_RESULT_EQUAL_TO |
|
0x00000304 |
|
Equal to == |
|
| |
|
WP_RESULT_GREATER_EQUAL |
|
0x00000305 |
|
Greater Than >= |
|
| |
|
WP_RESULT_LESS_EQUAL |
|
0x00000306 |
|
Less Than Equal <= |
|
| |
|
WP_RESULT_NOT_EQUAL_TO |
|
0x00000307 |
|
Not Equal != |
|
| |
|
WP_RESULT_GREATER |
|
0x00000308 |
|
Greater Than > |
|
| |
|
WP_RESULT_LESS |
|
0x00000309 |
|
Less Than < |
|
| |
Math: |
|
|
|
|
|
| |
|
WP_RESULT_MATH_OPERATOR |
|
0x00000400 |
|
Math Group |
|
| |
|
WP_RESULT_MATH_ASSIGN |
|
0x00000401 |
|
Assign (Equal) = |
|
| |
|
WP_RESULT_MATH_PLUS |
|
0x00000402 |
|
Plus + |
|
| |
|
WP_RESULT_MATH_MINUS |
|
0x00000403 |
|
Minus - |
|
| |
|
WP_RESULT_MATH_MULTIPLY |
|
0x00000404 |
|
Multiply (pointer) * |
|
| |
|
WP_RESULT_MATH_DIVIDE |
|
0x00000405 |
|
Divide / |
|
| |
|
WP_RESULT_MATH_MODULUS |
|
0x00000406 |
|
Modulus % |
|
| |
|
WP_RESULT_MATH_INVERT |
|
0x00000407 |
|
Invert ~ |
|
| |
Bitwise Math: |
|
|
|
|
|
| |
|
WP_RESULT_BITWISE_OPERATOR |
|
0x00000500 |
|
Bitwise Group |
|
| |
|
WP_RESULT_MATH_AND |
|
0x00000501 |
|
Math And & |
|
| |
|
WP_RESULT_MATH_OR |
|
0x00000502 |
|
Math OR | |
|
| |
|
WP_RESULT_MATH_XOR |
|
0x00000503 |
|
Math XOR ^ |
|
| |
|
WP_RESULT_SHIFT_LEFT |
|
0x00000504 |
|
Shift Left << |
|
| |
|
WP_RESULT_SHIFT_RIGHT |
|
0x00000505 |
|
Shift Right >> |
|
| |
Postfix/Prefix: |
|
|
|
|
| |
|
WP_RESULT_POSTFIX |
|
0x00000600 |
|
Postfix Group |
|
| |
|
WP_RESULT_INCREMENT |
|
0x00000601 |
|
Increment ++ |
|
| |
|
WP_RESULT_DECREMENT |
|
0x00000602 |
|
Decrement -- |
|
| |
|
WP_RESULT_NAMESPACE |
|
0x00000603 |
|
Namespace :: |
|
| |
|
WP_RESULT_MEMBER |
|
0x00000604 |
|
Member . |
|
| |
|
WP_RESULT_MEMBER_POINTER |
|
0x00000605 |
|
Member as Pointer -> |
|
| |
Assignment: |
|
|
|
|
|
| |
|
WP_RESULT_ASSIGNMENT |
|
0x00000700 |
|
Assignment Group |
|
| |
|
WP_RESULT_ASSIGN_PLUS |
|
0x00000701 |
|
Assign w/Plus += |
|
| |
|
WP_RESULT_ASSIGN_MINUS |
|
0x00000702 |
|
Assign w/Minus -= |
|
| |
|
WP_RESULT_ASSIGN_MULTIPLY |
|
0x00000703 |
|
Assign w/Times *= |
|
| |
|
WP_RESULT_ASSIGN_DIVIDE |
|
0x00000704 |
|
Assign w/Divide /= |
|
| |
|
WP_RESULT_ASSIGN_MODULUS |
|
0x00000705 |
|
Assign w/Modulus %= |
|
| |
|
WP_RESULT_ASSIGN_AND |
|
0x00000706 |
|
Assign w/Bitwise AND &= |
|
| |
|
WP_RESULT_ASSIGN_OR |
|
0x00000707 |
|
Assign w/Bitwise OR |= |
|
| |
|
WP_RESULT_ASSIGN_XOR |
|
0x00000708 |
|
Assign w/Bitwise XOR ^= |
|
| |
|
WP_RESULT_ASSIGN_SHIFT_LEFT |
|
0x00000709 |
|
Assign w/Shift Left <<= |
|
| |
|
WP_RESULT_ASSIGN_SHIFT_RIGHT |
|
0x0000070A |
|
Assign w/Shift Right >>= |
|
| |
Non-C(ish): |
|
|
|
|
|
| |
|
WP_RESULT_NON_C |
|
0x00000800 |
|
Non-C Group |
|
| |
|
WP_RESULT_NC_NOT_EQUAL |
|
0x00000801 |
|
Not Equal <> |
|
| |
|
WP_RESULT_NC_ASSIGN_CAT |
|
0x00000802 |
|
Assign and Cat .= |
|
| |
|
WP_RESULT_NC_EQUAL_TYPE |
|
0x00000803 |
|
Equal Strict === |
|
| |
|
WP_RESULT_NC_NOT_EQUAL_TYPE |
|
0x00000804 |
|
Not Equal Strict !== |
|
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
Page revised 2026-11-16
© 2012-2026 Novaworks, LLC. All rights reserved worldwide.
Unauthorized use, duplication or transmission is prohibited by law. Portions of the software are protected by US Patents 10,095,672,
10,706,221 and 11,210,456. Novaworks, GoFiler™ and Legato™ are registered 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 the 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.