Anark Core SDK
Loading...
Searching...
No Matches
Anark.CoreSdkApi.ISdkProgressTracker Interface Reference

An interface for tracking progress of a task. More...

Inheritance diagram for Anark.CoreSdkApi.ISdkProgressTracker:
Anark.CoreSdkApi.SdkProgressTracker

Public Member Functions

void Init (long numberOfItems)
 Use this to tell the progress tracker how much work is anticipated.
void FinishedItem ()
 Call this each time an item is processed.
void SetNumberOfItemsFinished (long numFinished)
 Use this only for random access scenarios such as when progress could move backward.
void SetStatus (string value)
 Set a status message to indicate to the user what is occurring.

Detailed Description

An interface for tracking progress of a task.

Member Function Documentation

◆ FinishedItem()

void Anark.CoreSdkApi.ISdkProgressTracker.FinishedItem ( )

Call this each time an item is processed.

Implemented in Anark.CoreSdkApi.SdkProgressTracker.

◆ Init()

void Anark.CoreSdkApi.ISdkProgressTracker.Init ( long numberOfItems)

Use this to tell the progress tracker how much work is anticipated.

Parameters
numberOfItemsThe number of items to be processed.

Implemented in Anark.CoreSdkApi.SdkProgressTracker.

◆ SetNumberOfItemsFinished()

void Anark.CoreSdkApi.ISdkProgressTracker.SetNumberOfItemsFinished ( long numFinished)

Use this only for random access scenarios such as when progress could move backward.

Implemented in Anark.CoreSdkApi.SdkProgressTracker.

◆ SetStatus()

void Anark.CoreSdkApi.ISdkProgressTracker.SetStatus ( string value)

Set a status message to indicate to the user what is occurring.

Parameters
valueThe status message.

Implemented in Anark.CoreSdkApi.SdkProgressTracker.