status

<status> is used to return the status of an operation or event. More than one <status> can be returned for each operation or event. <status> can also be included in an input from the driver to DirXML when the driver wants to log status of the driver to the DirXML log.

Possible values for the level attribute are:

success
Operation or event was successful.
warning
Operation or event was partially successful.
error
Operation or event failed.
fatal
A fatal error occurred, driver should be shut down.
retry
Application server was unavailable, send this event or operation later.

Standard values for the type attribute include:

app-general
General responses from an application API.
app-authentication
Related to application authentication requests.
app-connection
Identifies a change in the availability of an application.
driver-general
Identifies a response generated by a driver.
driver-status
A driver state change occurred.
password-set-operation
Identifies a response to a application password set or change event.
remoteloader
Messages generated by the DirXML Remote Loader.

If a <status> is not returned for a particular event or command, it is assumed to have succeeded.

Examples

<status event-id="0" level="success"/>

<status event-id="0" level="warning">Objects in the rear view mirror may be closer than they appear!</status>

<status event-id="0" level="warning" type="driver-status">Driver state changed to Stopped.</status>

1. Allowed Content

ANY

2. Attributes

AttributeValue(s)Default Value
event-id CDATA
An identifier used to tag the results of an event or command.

Should be the same as the event-id of the operation or event that this status is associated with.
#IMPLIED
level fatal   |  error   |  warning   |  success   |  retry
The status level.
#REQUIRED
type CDATA
An identifier used to classify the <status> for reporting purposes.
#IMPLIED

3. Content Rule

ANY

4. Parent Elements

input
  Input events or commands.
output
  Results of events or commands.

Top Elements || All Elements || Tree


NDS DTD