ClientUser::CreateProgress( int, P4INT64 )

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
  P4INT64 filesize minimum size of file to not be ignored

Returns

*ClientProgress

a pointer to the new ClientProgress object.

Notes

Files smaller than 1K are ignored by the ClientUser::CreateProgress( int ) method, but you can use this method to set a different minimum file size with the P4INT64 argument.

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, and call it only when a progress indicator is desired.)

The API calls this method with the appropriate ProgressType as defined in clientprog.h. The following ProgressTypes can be reported:

Client Progress Type Value Meaning

CPT_SENDFILE

1

Files sent to server

CPT_RECVFILE

2

Files received from server

CPT_FILESTRANS

3

Files transmitted

CPT_COMPUTATION

4

Computation performed server-side

See also

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