Error Provider::ReportEvent


Raises an error from an event source to the Microsoft® Windows® Application event log. Used by Microsoft® Provisioning Framework (MPF).

XML Input Schema

The following code fragment shows the format for sending data to this procedure. For more information on individual elements and attributes, see the Elements and Attributes table.

<executeData>1..1
  <hr>0..1</hr>
  <source>0..1</source>
  <parameters>0..1
	<parameter>0..unbounded</parameter>
  </parameters>
</executeData>

XML Output Schema

ReportEvent does not return data.

Elements and Attributes

The following table describes the XML elements and attributes. Unless otherwise indicated, the data type is string.

Element Description, relationships, and attributes
executeData Description:
Encapsulates the procedure's input data.

Children:
hr (minOccurs="0" maxOccurs="1")
parameters
(minOccurs="0" maxOccurs="1")
source (minOccurs="0" maxOccurs="1")

hr Description:
HRESULT for the event to raise. This should map to a valid event in the message file registered for the source. If the hr node is not specified, the HRESULT is assumed to be E_MPF_GENERIC_ERROR.

Parent:
executeData

parameter Description:
Parameter for the event.

Parent:
parameters

parameters Description:
List of parameters to pass for the event. Optional; used only if the event message requires parameters.

Parameters are passed by order. For example, the first parameter in the parameters list maps to "%1" in the event message. You must pass as many parameters as the thrown event message expects.

E_MPF_GENERIC_ERROR expects a single parameter: a string containing the full text of the error message.

Parent:
executeData

Child:
parameter
(minOccurs="0" maxOccurs="*")

source Description:
Source for the reported event. The source does not necessarily have to be an MPF event; ReportEvent can operate on any event source. If source is not specified, it is assumed to be "Provisioning."

Parent:
executeData

Remarks

To prevent the provider from logging events to the event log, you can create the following registry entry.

See Also

Error Provider


Up Top of Page
© 1999-2002 Microsoft Corporation. All rights reserved.