  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Twenty-one — EDGARView Integration (continued)
EDGARResponseGetMessages Function
Overview
The EDGARResponseGetMessages function returns a table containing all the parsed error and warning messages contained in the response message.
Syntax/Parameters
Syntax
string [][] = EDGARResponseGetMessages ( string data | handle hMessage );
Parameters
data
A string containing the response message. Or,
hMessage
A handle to a Response Message Object.
Return Value
A string table containing the messages returned in the response message or an empty list on failure. Use the GetLastError function to retrieve a formatted error code.
Note that if there are no messages in the response message (i.e., it was accepted), the table will be empty and last error code will be ERROR_EOD.
Remarks
Data returned in the table is formatted by a row for each class and a column for each item data. The columns have the following key names:
| Key Name | Description | ||
| TypeBits | Raw message type code in hexadecimal. | ||
| Level | The string ‘Error’, ‘Warning’ or ‘Unknown’. | ||
| Type | The string ‘EDGAR’, ‘XBRL’ or ‘Unknown’. | ||
| EnhancedMessage | If an enhanced message is available from the knowledge, a value will be present. This message is not from the SEC EDGAR System. | ||
| EDGARCode | EDGAR system code such as ‘INVALID_INLINE_TAG’. | ||
| Message | Unprocessed EDGAR message (line returns removed). | ||
| Element | If the XBRL, XML or HTML element can be discerned, the offending element name. | ||
| LineNumber | If provided, the line number of the error in the source file. Note that most response messages contain line number 0 or -1. |
Type bits are as follows:
/* * Type */
#define EM_LIST_TYPE_MASK 0xF0000000 /* Type Mask */
#define EM_LIST_NULL 0x00000000 /* Undefined Type (EOL) */
#define EM_LIST_WARNING 0x10000000 /* Warning Message */
#define EM_LIST_ERROR 0x20000000 /* Error Message */
/* * Source */
#define EM_LIST_SOURCE_MASK 0x0000000F /* Source Mask */
#define EM_LIST_EDGAR_XML 0x00000001 /* EDGAR XML Error Message */
#define EM_LIST_XBRL 0x00000002 /* XBRL Message */
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE
| 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.