KeywordType Complex Type

  • Article

Defines a keyword that identifies a category of events. A keyword is a tag that you attach to an event to group events based on their usage.

<xs:complexType name="KeywordType"
    mixed="true"
>
    <xs:simpleContent>
        <xs:extension
            base="xs:string"
        >
            <xs:attribute name="name"
                type="QName"
                use="required"
             />
            <xs:attribute name="symbol"
                type="CSymbolType"
                use="optional"
             />
            <xs:attribute name="mask"
                type="HexInt64Type"
                use="required"
             />
            <xs:attribute name="message"
                type="strTableRef"
                use="optional"
             />
            <xs:anyAttribute
                processContents="lax"
                namespace="##other"
             />
        </xs:extension>
    </xs:simpleContent>
</xs:complexType>

Attributes

Name Type Description
mask HexInt64Type A bitmask that must have only a single bit set. The bit represents a category of events (for example, read events or write events). You can specify bit values in the range from 0x0000000000000001 through 0x0000800000000000 (bits 0 through 47).
message strTableRef The localized display name for the keyword. The message string references a localized string in the stringTable section of the manifest.
name QName The name of the keyword. The name must be unique within the list of keywords that the provider defines.
symbol CSymbolType The symbol to use to reference the keyword in your application. The Message Compiler (MC.exe) uses the symbol to create a constant for the keyword in the header file that the compiler generates. If you do not specify a symbol, the compiler generates one for you.

Remarks

The Winmeta.xml file that is included in the Windows SDK contains a list of keywords. These keywords are reserved and should not be used.

Requirements

Requirement Value
Minimum supported client
 Windows Vista [desktop apps only]
Minimum supported server
 Windows Server 2008 [desktop apps only]