#include <backgroundentry.h>
BackgroundEntryInterface provides informations about a background entry. It's the base class for BackgroundProgressInterface.
◆ STATE
Enumerator |
---|
NONE | |
SUCCEEDED | Background Task succeeded.
|
CANCELED | Background Task was canceled.
|
WARNING | Background Task has warnings.
|
ERROR | Background Task has errors.
|
◆ MAXON_INTERFACE()
◆ MAXON_ENUM_FLAGS_CLASS()
◆ GetName()
GetName returns the name of the entry.
◆ GetStartTime()
GetStartTime returns the time when the entry has been created (so it is the start time).
◆ GetDuration()
GetDuration returns the duration of the entry.
◆ GetState()
GetState returns the overall state of the entry. The highest level (e.g. error) defines the state.
◆ GetStates()
GetStates iterates over all state entries and calls the value receiver for each.
- Parameters
-
[in] | state | ValueReceiver which is called for every entry in the list. Return false to stop the iteration immediately. |
- Returns
- The return value of the ValueReceiver. True if all values were iterated and the callback did not stop the iteration.
◆ GetStateCount()
GetStateCount description.
- Returns
- OK on success.
◆ AddState()
AddState adds a new state message to the entry.
- Parameters
-
[in] | state | see STATE. |
[in] | message | Text of the message. |
- Returns
- OK on success.