CaptureStateOnStart in EventProvider

  • Article

Represents a collection of keywords that describe events to be captured at the start of a recording. The library requests the provider to log its state information when the provider is enabled. If the Operation attribute is specified, the Keyword elements can be set or added to the collection.

Element Hierarchy

Syntax

<CaptureStateOnStart Operation = "Set" | "Add"> | “Remove”

  <!-- Child elements -->
  Keyword

</CaptureStateOnStart>

Attributes and Elements

Attributes

Attribute Description Data type Required Default
Operation Indicates whether keywords should be set or added. This attribute can have one of the following values:
  • Set
  • Add
  • Remove
 No Set

Child Elements

Element Description Requirement
Keyword (in EventProvider) Describes the Event Tracing for Windows (ETW) keyword for a user-mode provider. Required, one or more.

Parent Elements

Element Description
EventProvider Represents an event provider for the profile.
EventProviderId Represents an event provider identifier.

Example

The following code example shows how this element is used.

<EventProvider Id="sample-provider" Name="SampleProvider" NonPagedMemory="true" Level="5">
  <Keywords>
    <Keyword Value="0x98"/> <!-- Provider is enabled with these keywords throughout tracing session -->
  </Keywords>
  <CaptureStateOnStart>
    <Keyword Value="0xff4"/> <!-- Provider is  enabled with these keywords when tracing is started. -->
  </CaptureStateOnStart>
  <CaptureStateOnSave>
    <Keyword Value="0x118"/> <!-- Provider is enabled with these keywords when tracing is saved. -->
  </CaptureStateOnSave>
</EventProvider>

Elements

CustomKeyword

CaptureStateOnSave