DialogAddPasswordEntry Function

Help Contents

Introduction

Adds a Password Entry Box to the current dialog.

Syntax

Informal Syntax:

DialogAddPasswordEntry( Prompt, Target )

Formal Syntax:

DialogAddPasswordEntry( Prompt:=Expression, Target:=Variable Reference )

Parameters

ParameterTypeDescription
Prompt ANY_STRING The prompt string associated with the text entry field.
Target REF_TO ANY_STRING A reference to a program variable:
  • The Password Entry Box is initialized with the value of the program variable when the dialog is opened.
  • The contents of the Password Entry Box is written to the program variable when the dialog is closed.

Return Value

None.

Remarks

The Password Entry Box conceals the characters typed into it.

Requires Fernhill SCADA version 3.95 or later.

Examples

  1. Use DialogAddPasswordEntry to add a password entry box to a dialog:
    VAR Password : STRING; DialogResult : INT; END_VAR
    
    DialogNew();
    DialogAddPasswordEntry( "Password", Password );
    DialogResult := DialogOpen( "Enter Password", 1 );
    IF DialogResult = 1 THEN
        (* Add code here to do something with Password *)
    END_IF

Further Information

Operator Actions

To learn where you can use this function.

Glossary

For the meaning of terms used in Fernhill SCADA.