WinFree

Removes the active display window. Be aware that the last window (and any child windows owned by the last window) cannot be removed. You cannot call this function as an exit command (see Page Properties) or from a Cicode Object.

Notes

• This function cannot be used in the CitectSCADA Web Client.
• This function is not supported in the server process in a multiprocessor environment. Calling this function from the server process results in a hardware alarm being raised.

Syntax

WinFree()

Return Value

0 (zero) if successful, otherwise an error is returned.

Related Functions

WinNew, WinNewAt

Example

WinFree();

! Removes the active display window.

See Also

Window Functions