StepResult Class

Reference

Definition

Namespace:: Microsoft.Hpc.Diagnostics.Helpers

Assembly:: Microsoft.Hpc.Diagnostics.Helpers.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Contains information about the result of a stage in a diagnostic test.

public class StepResult : IComparable<Microsoft.Hpc.Diagnostics.Helpers.StepResult>

type StepResult = class
    interface IComparable<StepResult>

Public Class StepResult
Implements IComparable(Of StepResult)

Inheritance: Object
StepResult

Implements: IComparable<StepResult>

Constructors

StepResult()

Initializes a new instance of the StepResult class.

Properties

BulletPoints	Retrieves or sets the set of items in a bulleted list in the report for a diagnostic test run.
Environment	Retrieves or sets the set of environment variables that a diagnostic test should use set for the RunStep stage of the test.
ExceptionMessage	Retrieves or sets the exception message that is generated by the command that created the Step Result XML.
FailedNodes	Retrieves or sets the list of failed nodes for a diagnostic test run.
FullPath
IsSummary	Gets or sets whether the StepResult object represents a summary of the results for all of the nodes in the test or the results for just one node.
Message	Retrieves or sets the message for a stage in a diagnostic test.
NodeName	Retrieves or sets the name of the node for which the StepResult object contains the results of a diagnostic test run.
Nodes	Retrieves or sets the list of nodes on which the RunStep stage of a diagnostic test should run.
Parameters	Retrieves or sets the list of parameters that the diagnostic test should include in the RunStep command for all of the nodes in the diagnostic test.
ParentPath
Result	Retrieves or sets the result of the diagnostic test run for the node that the NodeName property specifies, or for the entire diagnostic test run if NodeName is Summary.
Tables	Retrieves or sets the list of tables that the report for the diagnostic test run should include for the result.

Methods

AddBulletPoint(StepResult+InformationType, String, Object[])	Adds an item to the bulleted list for the StepResult object with the specified type and message.
AddTable(StepResult+Table)	Adds the specified table to the StepResult object.
CompareTo(StepResult)	Compares this instance of the StepResult object with another specified StepResult object and indicates whether this instance precedes, follows, or appears in the same position in the StepResult.ResultCode order as the specified StepResult object. The order of the possible StepResult.ResultCode values from first to last is Failure, Warning, Success, Complete, and NoResult.
DeSerializeFromFile(String)	Deserializes the XML in the specified file and creates a StepResult object with property values that match the information in the file.
DeSerializeFromString(String)	Deserializes the XML in the specified string and creates a StepResult object with property values that match the information in the string.
GetResultsFromDirectory(String)	Deserializes the XML in the set of node_name.out files in the specified directory and creates a list of StepResult objects with property values that match the information in the files.
RaiseResultLevel(StepResult+ResultCode)
XmlSerializeToFile(String)	Serializes the properties of the StepResult object into XML and saves the result in the specified file.
XmlSerializeToStandardOut()	Serializes the properties of the StepResult object into XML and sends the result to standard output.
XmlSerializeToStream(Stream)	Serializes the properties of the StepResult object into XML and saves the results by using the specified Stream.

Applies to