Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter FiveGeneral 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

Platform Support

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

Legato IDE, Legato Basic