Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter TwoLanguage Overview (continued)

SecureClear Function

Overview

The SecureClear function wipes a variable’s reference memory and clears the internal working string pool.

Syntax/Parameters

Syntax

int = SecureClear ( [var name] );

Parameters

name

An optional variable name.

Return Value

Returns an int as ERROR_NONE or a formatted error code on failure.

Remarks

The SecureClear function helps support the Secure Memory Model by zeroing all allocated memory for a variable, even if an additional area has not been accessed. This is of particular interest with string data.

Whether a variable name is provided, the function also sets a flag that causes the script engine to clear its internal working string pool, which is used to store transient information from the floor of the current function stack level to the end. In addition, a flag is set causing the local variable pool to be cleared on function exit.

SecureClear should be used on variables or within functions that contain sensitive information or if sensitive information has been processed and the programmer wants an extra level of protection against a memory snooping program.

Related Functions

Platform Support

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

Legato IDE, Legato Basic