CaptureStateOnSave in SystemProvider

  • Article

Represents a collection of keywords that triggers the kernel rundown of those keywords (kernel flags) at the end of the trace. If the Operation attribute is specified, the Keyword elements can be set or added to the collection.

Element Hierarchy

Syntax

<CaptureStateOnSave Operation = "Set" | "Add"> | “Remove”
  <!-- Child elements -->
  Keyword (System),
  CustomKeyword
</CaptureStateOnSave>

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 SystemProvider) Describes the kernel flags for a SystemLogger session. Required, one or more.

Remark

The rundown of the system keywords automatically happens by WPR at the end of the trace. Use CaptureState* element if

  • you want the rundown of system keywords that are not currently on
  • you know the rundown will not happen because of the system shutdown
  • you want to initiate the rundown at specific time.

Set RundownFlag to Start if the kernel keyword is being enabled, for example at the start of the trace, or Stop if the keyword is being disabled.

Parent Elements

Element Description
SystemProvider Represents an system provider for the profile.
SystemProviderId Represents an system provider identifier.

Example

The following code example shows how this element is used.

    <SystemProvider Id="SystemProvider_CaptureStateOnDemand">
        <Keywords>
            <Keyword Value="MemoryInfo" />
        </Keywords>
        <CaptureStateOnSave>
            <Keyword Value="Pool" RundownFlag="Stop"/>
        </CaptureStateOnSave>
    </SystemProvider>
</SystemProvider>

Elements

Keyword (in SystemProvider)

CustomKeyword

CaptureStateOnStart in SystemProvider

CaptureStateOnDemand in SystemProvider