Support object
Provides status and progress reporting capability to assessments. Enables assessments access to configuration parameters that have been defined by the job author.
When to implement
Never. This is an object implemented and exposed by AXE.
- Methods
- Properties
Methods
The Support object has these methods.
| Method | Description |
|---|---|
| CreateLogger | Retrieves a Logging object. |
| Dispose | Overloaded. Releases all resources used by the object. |
| GetErrorText | Retrieves an Axe error message given the Axe error code. |
| GetParameterSet | Retrieves the specified set of parameters. |
| Initialize | Initializes AXE and instantiates the Support object. |
| ManageSystemState | Retrieves a SystemState object that is bound to a file use to save and restore the system configuration. |
| ProcessIdleTasks | Requests the system run the maintenance tasks scheduled to run when the system is idle. This prevents the maintenance tasks from running during the assessment. |
| ReportProgress | Reports the progress of the assessment to the AXE engine and can inform the assessment if it should stop running. |
| StartTracing | Begins advanced ETW tracing using a Windows Performance Analyzer (WPA) profile. |
| StopTracing | Finishes advanced ETW tracing using a Windows Performance Analyzer (WPA) profile. |
| SystemSettingCheckBoolean | Retrieves the current setting of a specific system configuration item. |
Properties
The Support object has these properties.
| Property | Access type | Description |
|---|---|---|
| Read-only | Determines if there has been a request for the assessment to cancel its operation. |
|
| Read-only | Retrieves the handle to an event that Axe signals when a solution requests the assessment should stop running. |
|
| Read-only | Determines if the Axe engine is running, which tells an assessment if it is running under Axe. |
Requirements
Minimum supported client |
Windows 8 [desktop apps only] |
Minimum supported server |
Windows Server 2012 [desktop apps only] |
DLL |
Microsoft.Assessments.Core.dll ; AxeCore.dll |
Send comments about this topic to Microsoft
Build date: 10/2/2013