  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Fourteen — Project Functions (continued)
Overview
The ProjectGetValidator function returns the properties associated with a specific validator index.
Syntax/Parameters
Syntax
string [] = ProjectGetValidator ( int index );
Parameters
index
An int from 0 to the maximum number of validators.
Return Value
Returns a string array containing the properties associated with the specified validator or an empty array on error. Use the GetLastError function to retrieve error information.
Remarks
Each of the properties is identified with named keys as follows:
| Element Key Name | Description | ||
| FileTypeCode | A string as a hex code representing the file type associated with the validator. Note that these values may change from application version to version. | ||
| FileType | File type in string form (e.g., FT_HTML). | ||
| Hook | The name of the attached hook. The value will be “(internal)” if the hook is handled by the application. Otherwise, it will be the name of the attached script. | ||
| DefaultMessageString | A string to place in the log if there is no attached validator. | ||
| DefaultMessageType | A string as a decimal value as the type of message to place in the log. See Log Message Types in Chapter 5. |
Use the GetLastError function to differentiate between an empty return array caused by an empty validator slot or caused by an error.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
| Table of Contents | < < Previous | Next >> |
© 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.