ClientUser::CreateProgress( int )

Create a ClientProgress object by subclassing, or null if no progress indicator is desired.

Virtual?

Yes

 

Class

ClientUser

 

Arguments

int ProgressType

The type of progress to be reported. See Progress types in the ClientProgress class overview.

Returns

*ClientProgress

A pointer to the new ClientProgress object.

Notes

Files smaller than 1K are ignored by default. To change this behavior, override the ClientUser::CreateProgress( int, P4INT64 ) method.

To enable progress reporting for a command, create a ClientProgress object and then implement ProgressIndicator() to return 0 or 1 depending on whether or not you want to enable the progress indicator. You typically implement ProgressIndicator() to return 1.

The API calls this method with the appropriate ProgressType as defined in clientprog.h.

See also

ClientProgress