Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter FiveGeneral Functions (continued)

PasswordBox Function

Overview

The PasswordBox function displays a query for a password with an optional title and description.

Syntax/Parameters

Syntax

string = PasswordBox ( [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.

Remarks

The dialog does not store or validate the password except that a password is required to continue.

While the title and description parameters are limited in number of characters, they are also limited in the available display size. The description is limited to displaying two lines of text. Return and other control characters are not allowed.

An example of the default operation:

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