Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter Twenty-oneEDGARView Integration (continued)

EDGARArchiveGetObjectType Function

Overview

The EDGARArchiveGetObjectType function will return the type of archive.

Syntax/Parameters

Syntax

int = EDGARArchiveGetObjectType ( handle hArchive );

Parameters

hArchive

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

Return Value

An int value: 0 for EDGAR Archive and 1 for Return Copy. If the handle is invalid, a formatted error code will be returned.

Remarks 

Return Copy style archives only contain document information while EDGAR Archives will contain additional submission parameters such as registrant information.

The function can be useful as part of subroutines that accept archive object handles and are not aware of the of object handle provided.

Related Functions

Platform Support

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

Legato IDE, Legato Basic