FrameShutdownUser

Note: This page includes content based on the F1 documentation for Centura development. It may be partially converted to support APF development, but should be regarded to be of uncertain actuality. It is provided as is. Eventually, it should be replaced by documentation available from within Visual Studio.

SalBoolean FrameShutdownUser( SalNumber nWhat )

Applications override the FrameShutdownUser to perform shutdown logic for a window.

Parameters

Name Description
SalNumber nWhat Standard method parameter. Possible values are Const.METHOD_Inquire, Const.METHOD_Execute.

Returns

When nWhat = Const.METHOD_Inquire: applications should return TRUE if the window can be shut down, FALSE otherwise. Returning FALSE will prevent the window from being closed.

When nWhat = Const.METHOD_Execute: applications should return TRUE if the shutdown actions were performed successfully, FALSE otherwise. Returning FALSE will prevent the window from being closed.

Comments

The framework calls FrameShutdownUser with Const.METHOD_Inquire when the user selects to close the window (while the Sys.SAM_Close message is being processed), and with Const.METHOD_Execute just before the window is destroyed.