ClientUser::ProgressIndicator()

Returns nonzero if progress is to be reported, otherwise returns 0.

Virtual?	Yes
Class	ClientUser
Arguments	None
Returns	int	returns non-zero if progress indicators are desired, 0 otherwise

Notes

After you have created a ClientProgress object with CreateProgress(), you must also implement ProgressIndicator() to return 0 or 1 depending on whether or not you want to report progress.

See also

ClientUser::CreateProgress()ClientProgress::Description()ClientProgress::Done()ClientProgress::Total()ClientProgress::Update()

Example

The typical implementation of ProgressIndicator() returns 1, and you call it when you wish to enable progress reporting:

MyUserProgress::ProgressIndicator()
{
    return 1;
}