Registry Reference Document Conventions
Applies To: Windows Server 2003, Windows Server 2003 R2, Windows Server 2003 with SP1, Windows Server 2003 with SP2
Document Conventions
Each registry element documented in the Registry Reference has a page that includes following details: the name of the registry element, its registry path, and a description of the element. Optionally, the page might also include a change method, activation method, notes, tips, cautions, or cross-references to related entries.
Element name and Registry path
Element names are not unique within the registry, but are unique within their path. The registry path shows the location of the element in the registry. You can use the path to navigate to the element.
Data Type, Range, and Default Value
For registry entries only, the page includes a table with the data type, range, and default value.
| Data type | Range | Default |
|---|---|---|
Defines the length and type of data that can be stored in the entry. See Data Types in the Registry. |
Demonstrates the syntax or format of the data in the entry and provides the range of valid values. For example, 0 | 4 means that "0" and "4" are the only values permitted. Words that describe a range, but that are not part of the range, appear in italics. For example, IP address. Italics are also used to show the data units. For example, 1–60 seconds. |
The default is the value of an entry that has not been changed. If the entry does not necessarily appear in the registry, the default shows the value that describes how the system behaves without the registry entry. For example, if the system behaves as though the value is 0 if the entry is not in the registry, then the default value of an entry is 0. |
Description
For registry folders (DfOfSubtree, DfOfKey, and DfOfSubkey), the description explains what kinds of data are stored in the folder. It also explains which programs or services create or use the data in the folder.
For DfOfEntry, the description explains how the program or service interprets the value of the entry. If the entry has a range of values, then the description includes a table describing the effect of each value on the program or service.
Change Method
The change method describes the graphical user interface (GUI) or command-line method you should use to modify the element. Use these recommended methods whenever possible. If there is no change method described, then the element can be changed only by editing the registry directly.
Activation Method
The activation method describes additional steps that you must take to make changes to the element effective. Many changes are effective immediately if you make them by using the standard interfaces, rather than by editing the registry. However, to make some changes effective, you must restart a service, restart Windows, or log off and log on again.
Note
Notes provide additional information about the element. Typically, notes explain when the system adds an entry to the registry, qualifies the use of an entry, or describes the order of precedence of related entries.
Tip
Tips provide suggestions for using or learning more about the element.
Caution
Cautions describe the harm that might result if you add, change, or delete a registry element. Please take the cautions seriously. They are intended to protect your system.
Related Entries
Related entries are entries that configure the same component, or configure the same features on a different component. Related entries help you find the entry that meets your needs.