GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Twenty-one — EDGARView Integration (continued)

EDGARArchiveGetDocFileType Function

Overview

The EDGARArchiveGetDocFileType function will retrieve the document file type code for a specific document within the archive.

Syntax/Parameters

Syntax

dword = EDGARArchiveGetDocFileType ( handle hArchive, int index );

Parameters

hArchive

A handle that specifies the EDGAR Archive opened with EDGARArchiveOpen function.

index

An integer specifying a file entry in the mapped object.

Return Value

An dword (32-bit unsigned int) value specifying a file type or a formatted error code. On error, the GetLastError function will return the same error code.

Remarks

The EDGAR System supports only a limited number of file types and also generates a number of specific file types.

See Section 6.10 File Types for information on file types.

Related Functions

EDGARArchiveGetDocDescription — Gets the EDGAR Document ‘Description’.

EDGARArchiveGetDocType — Gets the EDGAR Document ‘Type’.

EDGARArchiveGetDocFile — Extracts a file and writes to a specified location with default filename or with a specified filename.

EDGARArchiveGetDocName — Gets the name (filename) of the document as filed.

FileTypeStringToCode — Translates a file type code string to a dword.

FileTypeCodeToString — Translates a file type code dword to a string.

GetFileTypeCode — Gets file type by file content or extension and return type as code dword.

GetFileTypeString — Gets file type by file content or extension and return type as string.

Platform Support

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

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/2024

© 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.