DialogAddValue Function

Help Contents

Introduction

Adds a text entry field to the current dialog, where the field is mapped to a program variable.

Informal Syntax:

DialogAddValue( Prompt, Target )

Formal Syntax:

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

Parameters

ParameterTypeDescription
Prompt ANY_STRING The prompt string associated with the text entry field.
Target ANY A reference to a program variable.

When the Target field is a BOOL value, the function creates a check box to represent the field value. For all other types of field, the function creates a text entry field to represent the field value.

Return value

None.

Example 1

Adds a check box field to the current dialog definition with the prompt "Start Pump":

VAR StartPump : BOOL; END_VAR

DialogAddValue( "Start Pump", StartPump );

Example 2

Adds a text entry field to the current dialog definition with the prompt "Set Point":

VAR SetPointValue : LREAL; END_VAR

DialogAddValue( "Set Point", SetPointValue );

Further Information

Operator Actions

To learn where you can use this function.

Glossary

For the meaning of terms used in Fernhill SCADA.