Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter Twenty-oneEDGARView Integration (continued)

EDGARSetCredentials Function

Overview

The EDGARSetCredentials function temporarily sets the EDGAR System access credentials.

Syntax/Parameters

Syntax

int = EDGARSetCredentials ( string cik, string password, string ccc );

int = EDGARSetCredentials ( string username, string password, string cik, string ccc
                        string totpsecret);

Parameters

cik

A string containing a CIK. The string must conform to CIK syntax. If the value exceeds 256 characters, a runtime error will occur.

password

A string containing a matching password for the CIK. The string must conform to password/CCC syntax. If the value exceeds 256 characters, a runtime error will occur.

ccc

A string containing a matching CIK Confirmation Code (CCC) for the CIK. The string must conform to password/CCC syntax. If the value exceeds 256 characters, a runtime error will occur.

username

A string containing the EDGAR Username. If the value exceeds 256 characters, a runtime error will occur.

totpsecret

A string containing the TOTP secret. If the value exceeds 48 characters, a runtime error will occur.

Return Value

An int as ERROR_NONE or a formatted error code on failure. The formatted error code will be ERROR_RANGE with the number of the offending field. Use the GetLastError and GetLastErrorMessage functions to retrieve additional error information.

Remarks

If any parameter is an empty string, the value is not adjusted. All strings are automatically trimmed for leading and trailing spaces prior to testing and storage. The CIK is automatically zero padded to make a ten-digit value.

The values are not validated against the EDGAR system. The CIK and password are required for login and the CCC is required for accessing any company information such as mailbox messages. If the EDGAR Next Beta is enabled the Username, Password and CIK are required for login and the CCC is required for accessing any company information such as mailbox messages.

Proper security precautions should be employed when storing and using CCCs and passwords. This function abides by the Secure Memory Model.

Related Functions

Platform Support

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

Legato IDE