ClientProgress::Done( int )

Called when an operation completes.

Virtual?

Yes

 

Class

ClientProgress

 

Arguments

int fail

operation status: 1 if failed, 0 if successful

Returns

void

 

Notes

The API calls Done() on command completion with 0 for success, or 1 for failure.

See also

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

Example

To change the way completed actions are reported, create a subclass of ClientProgress and define an alternate implementation of Done(). For example, to output "Command failed" or "Command completed" upon success or failure, implement Done() as follows:

void MyProgress::Done( int fail )
{
    printf( fail ? "Command failed\n" : "Command completed\n");
}