MethodProgressStepAdd

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.

SalNumber MethodProgressStepAdd( SalNumber nStep )

The MethodProgressStepAdd is called as a part of the implementation of MethodProgressCount, to add steps to the total number of steps needed to complete the method.

Parameters

Returns

This method does not return a value.

Comments

The reason MethodProgressCount can not simply return the complete number of steps requires, but has to use MethodProgressStepAdd, is to allow for a method to be implemented collectively by several objects.

When MethodProgressCount is called in the object that started the method, that object makes sure that all objects participating in the method call MethodProgressAdd to specify how many steps are required in each participating object. This way, objects only need to know how many steps they themselves require to complete the method. They do not need to know how many steps are required in other objects.

Example

Function: MethodProgressCount
Actions
   ! Add steps needed in this object
   Call MethodProgressStepAdd( 5 )
   ! Count steps needed in participating objects
   Call tblOrderLines.MethodProgressCount( )
   Call tblAddress.MethodProgressCount( )

new C# coding sample

public new SalNumber MethodProgressCount()
{
	#region Local Variables
	#endregion
	
	#region Actions
	using (new SalContext(this))
	{
		MethodProgressStepAdd(3);
	}
	return 0;
	#endregion 
}