  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Five — General Functions (continued)
Overview
The GetObjectMetaData function retrieves a named meta string from a compatible object.
Syntax/Parameters
Syntax
string = GetObjectMetaData ( handle hObject, string name );
string = GetObjectMetaData ( handle hObject, string section, string name );
string = GetObjectMetaData ( handle hObject,
string
title, string section, string name );
Parameters
hObject
A handle to a compatible object.
name
A string containing the case-sensitive name of the meta data to retrieve.
section
An optional string containing a case-sensitive section name for grouping.
title
An optional string containing a case-sensitive title for grouping.
Return Value
Returns a string value containing the meta data or empty string on failure. A named meta item can be an empty string. Use the GetLastError function to retrieve a formatted error code or IsError and IsNotError to determine if an error occurred.
Remarks
If the object does not support meta data, the error code will be set to ERROR_FUNCTION_NOT_SUPPORTED.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| 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.