TCallbackToolProgress

TCallbackToolProgress is used to get progress for individual tools from running workflows or wizards.

Returns 1 to cancel running the workflow or application or 0 to continue.

If the calling application determines the workflow or application should stop processing based on the contents of the callback, it should return 1. In order to allow processing to continue, it should return 0.

Method declaration

long CallbackToolProgress( 
	__int64 userData,
	int nToolId,
	double dPercentProgress
)

userData: The value of the userData parameter passed into the call to one of the following methods: AlteryxRunModule, AlteryxRunModule2, AlteryxRunModule_Pipe, AlteryxRunModule_Pipe2, AlteryxRunWizard, or AlteryxRunWizard_Pipe.

nToolId: The numeric ID for the tool that the progress is being reported from. -1 indicates progress coming directly from the Alteryx Engine.

dPercentProgress: A value between 0 and 1 indicating the percent completion for the tool.

Example

long CallbackToolProgress(System. __int64 userData, int nToolId, double dProgress)
{
  // do something with the progress information
  return 0;
}