WizardCancel

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 WizardCancel( SalNumber nWhat, SalString sStep )

The WizardCancel hook method is called by the framework when the user selects the Cancel button. Applications should override this method to add extra checks to see if the Cancel operation is available, or extra statements to be executed when the user chooses Cancel.

Parameters

Name Description
SalNumber nWhat Standard method parameter. Possible values are Const.METHOD_Inquire, Const.METHOD_Execute.
SalString sStep Name of the currently active step.

Returns

When nWhat = Const.METHOD_Inquire: applications should return TRUE if the Cancel operation is available, FALSE otherwise.

When nWhat = Const.METHOD_Execute: applications should return TRUE if the Cancel operation was successfully performed, FALSE otherwise.

Comments

If standard behavior is desired, there is no need to override this method.