Close

The Close event has different arguments for different objects:

Object

See

Application

Syntax 1

OLE control

Syntax 2

Window

Syntax 3


Syntax 1: For the application object

Description

Occurs when the user closes the application.

Event ID

Event ID

Objects

None

Application


Arguments

None

Return Values

None (do not use a RETURN statement)

Usage

The Close event occurs when the last window (for MDI applications the MDI frame) is closed.

See also

Open

SystemError

Syntax 2: For OLE controls

Description

Occurs when the object in an OLE control has been activated offsite (the OLE server displays the object in the server's window) and that server is closed.

Event ID

Event ID

Objects

pbm_omnclose

OLE


Arguments

None

Return Values

Long.

Return code: Ignored

Usage

If the user closed the OLE server, the user's choices might cause the OLE object in the control to be updated, triggering the Save or DataChange events.

If you want to retrieve the ObjectData blob value of an OLE control during the processing of this event, you must post a user event back to the control or you will generate a runtime error.

See also

DataChange

Save

Syntax 3: For windows

Description

Occurs just before a window is removed from display.

Event ID

Event ID

Objects

pbm_close

Window


Arguments

None

Return Values

Long.

Return code choices (specify in a RETURN statement):

0 -- Continue processing

Usage

When you call the Close function for the window, a CloseQuery event occurs before the Close event. In the CloseQuery event, you can specify a return code to prevent the Close event from occurring and the window from closing.

Do not trigger the Close event to close a window; call the Close function instead. Triggering the event simply runs the script and does not close the window.

See also

CloseQuery

Open