wf_openWizard()

The function opens a wizard.

Synopsis

int wf_openWizard(string sConfigDp, uint x, uint y, uint iconbar, uint menubar string ResizeMode, bool bEnableDuplicate);

Parameters

Parameter Description
sConfigDp Name of the data point used for the wizard
x Horizontal position in which the wizard window should be opened. Default: 0; A value of -1 indicates that the window should be opened in a centered position
y Vertical position in which the wizard window should be opened. Default: 0; A value of -1 indicates that the window should be opened in a centered position
iconbar Defines if the icon bar of the wizard is displayed. 0 => The default from the config file 1 = the icon bar is not shown 2 = the icon bar is shown
menubar Defines if the menu bar is displayed. 0 => The default from the config file 1 = the menu bar is not shown 2 = the menu bar is shown
ResizeMode Defines if the wizard can be resized. "" default value from the config file. "None" = scaling is deactivated in the VISION "Zoom" = scaling is only possible via the navigator.
bEnableDuplicate TRUE = Several wizards with the same data point can be opened simultaneously. FALSE = The wizard is reloaded.

Return Value

-1 wizard dp does not exist, -2 the dp is not a wizard configuration dp,

-3 wizard key was not defined, 0 the function was successfully executed.

Error

-

Description

The function opens a wizard.

Example

Opens a wizard (wizard configuration DP: _WF_wizard1) at the position 160(x),40 (y). You can resize the window and several wizards of the same data point can be opened simultaneously.

#uses "wizardFramework.ctl"
main()
{
  int i;
  string resMode;
  bool enabDup = TRUE;
  i = wf_openWizard("_WF_wizard1",160,40,2,2,resMode,enabDup);
}

Assignment

Wizard Framework

Availability

UI, CTRL