This function is used in Python Scripting.

Description

Given a window path, or a reference to a window itself, it will close the window. If the window can't be found, this function will do nothing.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.nav.closeWindow(window)

  • Parameters

FPMIWindow window - A reference to the window to close. Refer to the window objects.

  • Returns

Nothing

  • Scope

Vision Client

Syntax

system.nav.closeWindow(windowPath)

  • Parameters

String windowPath - The path of a window to close.

  • Returns

Nothing

  • Scope

Vision Client

Code Examples
Code Snippet
# This example gets the window named 'Overview' and then closes it.
# If the window isn't open, a warning is shown.
try:
   window = system.gui.getWindow('Overview')
   system.nav.closeWindow(window)
except ValueError:
   system.gui.warningBox("The Overview window isn't open")
Code Snippet
# This example closes the window named 'Overview' in one step.
# If the window isn't open, the call to closeWindow has no effect.
system.nav.closeWindow('Overview')
Keywords

system nav closeWindow, nav.closeWindow