Getting Progress Updates

This topic assumes that there is an instance of the PIXLClient object called pixl. If this is not the case, please see the Connecting To The PIXL topic.

The PIXL can provide updates that show the current progress through a command. The PIXLClient provides an OperationalStatus property and an OperationalStatusChanged event that can be used to retrieve the current status.

The OperationalStatus property includes the following information:

Name of the running command
Status of the running command
An estimated remaining duration before the running command is finished
The percentage complete of the current command

Subscribing to the OperationalStatusChanged event and displaying the status in the Console.	Copy Code
// Subscribe to the OperationalStatusChanged event. pixl.OperationalStatusChanged += (s, x) => { // Display the status on the Console. Console.WriteLine($"Command: {x.CommandName}"); Console.WriteLine($"Status: {x.CommandStatus}"); Console.WriteLine($"Percentage Complete: {x.ProgressAsPercentage}%"); Console.WriteLine($"Estimated Remaining Time: {x.EstimatedRemainingTime}"); };

Subscribing to the OperationalStatusChanged event and displaying the status in the Console.

Copy Code

// Subscribe to the OperationalStatusChanged event.
pixl.OperationalStatusChanged += (s, x) =>
{
    // Display the status on the Console.
    Console.WriteLine($"Command: {x.CommandName}");
    Console.WriteLine($"Status: {x.CommandStatus}");
    Console.WriteLine($"Percentage Complete: {x.ProgressAsPercentage}%");
    Console.WriteLine($"Estimated Remaining Time: {x.EstimatedRemainingTime}");
};

The last update can be checked at any time by reading the OperationalStatus property on the PIXLClient.

Getting Started

Connecting To The PIXL

Reference

OperationalStatus Property

OperationalStatusChanged Event