TProgress Struct Reference

The TProgress structure controls the display of training progress using a user-definable pointer and three callback functions. More...

Data Fields
void *	PPrivate
TProgressReport	ProgressReport
TReleaseProgressReport	ReleaseProgressReport
	Pointer to function to be called at the end of a progress phase.
TStartProgressReport	StartProgressReport

Detailed Description

The TProgress structure controls the display of training progress using a user-definable pointer and three callback functions.

Progress reporting is organized hierarchically i.e. a given progress phase may consist of sub phases, that are indicated by calls to the StartProgressReport callback, and inside the callbacks the different phases can be identified by their ID.

Attention

If any of the callback function pointers is NULL none of them will be called.

Field Documentation

PPrivate

void* PPrivate

Pointer to user-definable data (with which the progress information may e.g. be routed to the user-interface).

ProgressReport

TProgressReport ProgressReport

Pointer to function to be called on the completion of a single progress step.

StartProgressReport

TStartProgressReport StartProgressReport

Pointer to function to be called at the start of a new progress phase. Provides pointer to user-interface, an ID of the process or sub-process, a caption and a total number of steps to be expected.