Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter FiveGeneral Functions (continued)

PasswordRememberBox Function

Overview

The PasswordRememberBox function displays a query for a password with an optional title and description with an option to ‘remember’ the password.

Syntax/Parameters

Syntax

string = PasswordRememberBox ( [string title], [string description] );

Parameters

title

An optional string specifying the title of the password box to a maximum of 255 characters. If the string is empty, the default title is used.

description

An optional string specifying a description to be displayed in the top of the box to a maximum of 512. If omitted, this area of the dialog is collapsed.

Return Value

A string containing the password entered by the user or empty on failure. Use the GetLastError function to retrieve a formatted error code. The most typical error is ERROR_CANCEL.

On no error, the last error will be TRUE (1) if the ‘remember’ open was checked by the user.

Remarks

PasswordRememberBox operates in exactly the same manner as the PasswordBox function with the exception that a checkbox is provided to give the option for the application to remember the password.

The ‘remember’ option selection is returned in the last error field as 0 or 1. The dialog does not actually remember the password, it only returns the request.

Proper security precautions should be employed when storing and using 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, Legato Basic