CloseView()

Summary

Drops a view from the system.

Syntax

CloseView(string view_name)

Notes

• When a view is dropped from the system, the lists returned by GetViews() and GetViewNames() no longer include that view.

• If the input view is a geographic layer, CloseView() succeeds only if :

  • The layer is not in any map

  • Neither the layer nor any joined views containing the layer are being used by any editor or themes

• If these conditions hold, the layer, and all joined views containing the layer, are dropped together.

• If the input view is not a geographic layer (e.g., it is a joined view or a dBASE table), CloseView() succeeds only if the view itself is not displayed by any editor or used by any themes.

• Existing editors or themes may use a joined view containing the input view. As long as no editor or theme uses the input view itself, it is still successfully dropped.

• Joined views containing the input view remain valid.

• If the input view is a joined view and it is successfully dropped, the component views of the joined view are not dropped.

• If the view is the current view and it is successfully dropped, then the current view is set to null.

Example

CloseView("States")
// This loop closes all views:
vws = GetViewNames()
for i = 1 to vws.length do
CloseView(vws[i])
end

Error Codes

See Also