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

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

GetNthWord Function

Overview

The GetNthWord function retrieves a single word or item at a specified position.

Syntax/Parameters

Syntax

string  = GetNthWord ( string data,  [int position], [dword flags] );

wstring = GetNthWord ( wstring data, [int position], [dword flags] );

Parameters

data

A string or wstring specifying the source data. The source type dictates the return type.

position

An optional int specifying the zero-based nth word position to retrieve. If omitted, the position is set to 0 for the first word.

flags

An optional dword specifying the parse options. If omitted, the value is WP_GENERAL. The flag values are as follows.

	WP_GENERAL	0	General – stops on word spaces.
	WP_SGML_TAG	1	Tags – stops on tags (SGML, HTML, and XML).
	WP_PROGRAM	2	Program – stops on typical programmatic expressions.
	WP_PROGRAM_GROUP	3	Program Groups – same as mode 2 but returns complete groups for parenthesis (‘( )’), brackets (‘[ ]’), single quotes (‘ ' ' ’), and double quotes (‘ " " ’).
	WP_OBJECT_NOTATION	5	Object Notation — Stops on delimiters commonly used on object references such as ‘.’ ‘[‘ and ‘]’.

 

Return Value

Returns a string or wstring containing the word or empty on failure. Use the GetLastError function to retrieve error information. On success, the last error will contain the zero based index to the start of the word retrieved.

Remarks

The GetNthWord functions encapsulates the Word Parse Object and counts to the specified position and then returns the last word, assuming the item was found. If the word list is exhausted, the return value is an empty string.

The internal word buffer is limited to 1024 characters. Should a parsed string item be larger, the function will return empty string with an overflow error in the last error buffer. If the source cannot be controlled, it is best to use the GetLastError function to determine if a word is not available at the position or if an error occurred.

Related Functions

GetWordCount — Returns the number of parsed items within a string.

ScanString — Scans a string as a list delimited by spaces, commas or line endings.

WordParseCreate — Creates a Word Parse Object with options.

WordsToArray — Parses a string and returns an array of words.

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic

Page revised 2024-10-21

 

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.