  |
GoFiler Legato Script Reference
Legato v 1.4j Application v 5.22b
|
| Table of Contents | < < Previous | Next >> |
Chapter Eleven — SGML Functions (continued)
Overview
The XBRLGetFootnotes function returns a list of footnotes filtered by label (ID), language or text.
Syntax/Parameters
Syntax
string[][] = XBRLGetFootnotes ( handle hXM, [string filters[]], [dword nocase] );
Parameters
hXM
A handle to an XBRL Object containing instance information.
filters
An optional string array specifying option filters as match strings. Each string can contain wildcard characters. Missing filters are treated as all or “*”. If the filters parameter is not provided, all footnotes are returned.
nocase
An optional dword, if set to TRUE forces all compares as case-insensitive. The default value is FALSE. This parameter can only be used if the filters parameter is provided.
Return Value
Returns a string table of footnote properties or an empty array on failure. Use the GetLastError function to retrieve a formatted error code.
Remarks
Each matching item is placed in the resulting table as a row with named columns for each label. The column employs the key names specified at Section 11.20.12 Instance — Footnotes.
The filters use the following key names (a subset of the returned column key names:
label — Label ID.
language — Language code.
html_flag — If TRUE or FALSE will filter by the type of footnote text data.
text — Text as text or HTML.
Using an incorrect filter key name will result in an ERROR_PARAMETER being returned. The last error message will contain the name of the key that failed. If a filter is not used, it can be omitted from the array. The value of each filter is case sensitive.
XBRLGetFootnotes will scan the entire database of footnotes to provide the filtered data set. As such, do not use this function to locate a specific footnote by label name, rather use the XBRLGetFootnote function and either walk through the common items or filter further using the role qualifier. XBRLGetFootnote performs a fast binary search thus reducing the number of search iterations dramatically.
If there are no matching items, an empty array is returned.
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.