step-result Element

Article
02/16/2009

The <step-result> element gives the current run status of the step.

Usage

<step-result
    file = "file path"
    progress = "x/y"
/>

Attributes

Attribute	Type	Required	Description
file	file path	No	Contains the name of the file in certain step failures involving files (see Remarks).
progress	x/y	No	Contains a ratio of completion of the form x/y so the user interface can show a progress dialog box, if desired. This attribute is only expected when the step result inner value is "completing-referential-updates" or "completing-obsoletion".

file

file path

Contains the name of the file in certain step failures involving files (see Remarks).

progress

x/y

Contains a ratio of completion of the form x/y so the user interface can show a progress dialog box, if desired. This attribute is only expected when the step result inner value is "completing-referential-updates" or "completing-obsoletion".

Child Elements

Element	Description
run-status	A non-localized string that gives the current run status of this step. The list of possible status values are listed in WMI Provider Return Strings.

run-status

A non-localized string that gives the current run status of this step. The list of possible status values are listed in WMI Provider Return Strings.

Parent Elements

Element
<step-details>

Child Element Sequence

The tree shows the ordering and number of child elements. Child elements in a Sequence must appear in the order given and child elements in a Choice are mutually exclusive. Sequences and Choices can be nested. Element names are followed by the minimum and maximum occurrences.

run-status (Exactly 1)

Remarks

The file attribute gives the name of the file in the following step failures involving files. WMI Provider Return Strings gives descriptions of these run status values:

completed-no-objects
no-start-file-access-denied
no-start-file-contains-incorrect-step-type
no-start-file-not-found
no-start-file-open
no-start-file-sharing-violation
stopped-change-log-out-of-order
stopped-extension-dll-access
stopped-extension-dll-ambiguous
stopped-extension-dll-exception
stopped-extension-dll-file-not-found
stopped-extension-dll-instantiation
stopped-extension-dll-invalid-assembly
stopped-extension-dll-load
stopped-extension-dll-missing-dependency
stopped-extension-dll-no-implementation
stopped-extension-dll-updated-version

The progress attribute gives a ratio of completion in the form of x/y so the user interface can show a progress dialog box if desired. This attribute is set only when the run status is one of the following values. WMI Provider Return Strings gives descriptions of these run status values:

completing-obsoletion
completing-referential-updates

Element Information

Can be empty