PM_MethodAbort

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.

Const.PM_MethodAbort

The Const.PM_MethodAbort message is sent to a window when the user clicks the abort button in a progress bar.

Parameters

Returns

When nWhat = Const.METHOD_Inquire, applications should return TRUE if the window is capable of aborting (stopping) the method using the progress bar, FALSE otherwise.

When nWhat = Const.METHOD_Execute, applications should return TRUE if the method was successfully aborted, FALSE otherwise.

Example

This example uses the Const.PM_MethodAbort message to set the bSqlExecutorAbort flag, which in turn will cause the loop executing sql statements to terminate.

On PM_MethodAbort
   Select Case wParam 
       Case METHOD_Inquire
          Return TRUE
       Case METHOD_Execute
          Set bSqlExecutorAbort = TRUE

C# coding

private void cTreeListBox_MessageActions(ref SalMessage message)
{
	#region Actions
	switch (message.Code)
	{
		case Const.PM_MethodAbort:
			this.cTreeListBox_OnPM_MethodAbort(ref message);
			break;
	}
}
	
private void cTreeListBox_OnPM_MethodAbort(ref SalMessage message)
{
	#region Actions
	message.Handled = true;
	switch (Sys.wParam)
	{
		
		case Const.METHOD_Inquire:
			message.Return = true;
			return;
		
		case Const.METHOD_Execute:
			this.__bMethodAborted = true;
			break;
	}
	#endregion
}