Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 8 additions & 15 deletions xml/Microsoft.Win32/Registry.xml
Original file line number Diff line number Diff line change
Expand Up @@ -367,25 +367,23 @@ The following code example stores values of several data types in an example key
## Remarks
`LocalMachine` contains five keys:

Hardware
`Hardware`\
Describes the physical hardware in the computer, the way device drivers use that hardware, and mappings and related data that link kernel-mode drivers with user-mode code. All data in this key is recreated each time the system is started. The Description subkey describes the actual computer hardware. The DeviceMap subkey contains miscellaneous data in formats specific to particular classes of drivers. The ResourceMap subkey describes which device drivers claim which hardware resources. The Windows NT Diagnostics program (Winmsdp.exe) can report on its contents in an easy-to-read form.

SAM
The directory services database of security information for user and group accounts, and for the domains in Windows 2000 Server (SAM is the Security Account Manager, known as the directory services database).
`SAM`\
The directory services database of security information for user and group accounts, and for the domains in Windows Server (SAM is the Security Account Manager, known as the directory services database).

Security
Contains the local security policy, such as specific user rights. This key is used only by the Windows 2000 security subsystem.
`Security`\
Contains the local security policy, such as specific user rights. This key is used only by the Windows security subsystem.

Software
`Software`\
The per-computer software database. This key contains data about software installed on the local computer, along with various items of miscellaneous configuration data.

System
Controls system startup, device driver loading, Windows 2000 services, and operating system behavior.
`System`\
Controls system startup, device driver loading, Windows services, and operating system behavior.

By convention, if similar data exists under <xref:Microsoft.Win32.Registry.CurrentUser> and under <xref:Microsoft.Win32.Registry.LocalMachine>, the data in <xref:Microsoft.Win32.Registry.CurrentUser> takes precedence. However, values in this key can also extend (rather than replace) data in Registry.LocalMachine. Also, some items (such as device driver loading entries) are meaningless if they occur outside of Registry.LocalMachine.



## Examples
The following example demonstrates how to retrieve the subkeys of this key, and prints their names to the screen. Use the <xref:Microsoft.Win32.RegistryKey.OpenSubKey*> method to create an instance of the particular subkey of interest. You can then use other operations in <xref:Microsoft.Win32.RegistryKey> to manipulate that key.

Expand Down Expand Up @@ -442,11 +440,6 @@ The following code example stores values of several data types in an example key

To obtain performance data from a remote system, you must use the <xref:Microsoft.Win32.RegistryKey.OpenRemoteBaseKey*> method, with the computer name of the remote system and the Registry.PerformanceData key. This call retrieves a key representing the performance data for the remote system. To retrieve the data, call <xref:Microsoft.Win32.RegistryKey.GetValue*> using this key, rather than the Registry.PerformanceData key.

> [!NOTE]
> On Windows Server 2003, a user must at least belong to the Performance Monitor Users group in order to access subkeys of this base key.



## Examples
The following example demonstrates how to retrieve the subkeys of this key, and prints their names to the screen. Use the <xref:Microsoft.Win32.RegistryKey.OpenSubKey*> method to create an instance of the particular subkey of interest. You can then use other operations in <xref:Microsoft.Win32.RegistryKey> to manipulate that key. Note that this example can often return no results, since there might be no performance data.

Expand Down
122 changes: 55 additions & 67 deletions xml/Microsoft.Win32/RegistryKey.xml
Original file line number Diff line number Diff line change
Expand Up @@ -211,10 +211,10 @@
<exception cref="T:System.Security.SecurityException">The user does not have the permissions required to create or open the registry key.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:Microsoft.Win32.RegistryKey" /> on which this method is being invoked is closed (closed keys cannot be accessed).</exception>
<exception cref="T:System.UnauthorizedAccessException">The <see cref="T:Microsoft.Win32.RegistryKey" /> cannot be written to; for example, it was not opened as a writable key , or the user does not have the necessary access rights.</exception>
<exception cref="T:System.IO.IOException">The nesting level exceeds 510.
-or-
<exception cref="T:System.IO.IOException">The nesting level exceeds 510.

-or-

A system error occurred, such as deletion of the key, or an attempt to create a key in the <see cref="F:Microsoft.Win32.Registry.LocalMachine" /> root.</exception>
</Docs>
</Member>
Expand Down Expand Up @@ -277,10 +277,10 @@
<paramref name="permissionCheck" /> contains an invalid value.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:Microsoft.Win32.RegistryKey" /> on which this method is being invoked is closed (closed keys cannot be accessed).</exception>
<exception cref="T:System.UnauthorizedAccessException">The <see cref="T:Microsoft.Win32.RegistryKey" /> cannot be written to; for example, it was not opened as a writable key, or the user does not have the necessary access rights.</exception>
<exception cref="T:System.IO.IOException">The nesting level exceeds 510.
-or-
<exception cref="T:System.IO.IOException">The nesting level exceeds 510.

-or-

A system error occurred, such as deletion of the key, or an attempt to create a key in the <see cref="F:Microsoft.Win32.Registry.LocalMachine" /> root.</exception>
</Docs>
</Member>
Expand Down Expand Up @@ -340,10 +340,10 @@
<paramref name="subkey" /> is <see langword="null" />.</exception>
<exception cref="T:System.Security.SecurityException">The user does not have the permissions required to create or open the registry key.</exception>
<exception cref="T:System.UnauthorizedAccessException">The current <see cref="T:Microsoft.Win32.RegistryKey" /> cannot be written to; for example, it was not opened as a writable key, or the user does not have the necessary access rights.</exception>
<exception cref="T:System.IO.IOException">The nesting level exceeds 510.
-or-
<exception cref="T:System.IO.IOException">The nesting level exceeds 510.

-or-

A system error occurred, such as deletion of the key, or an attempt to create a key in the <see cref="F:Microsoft.Win32.Registry.LocalMachine" /> root.</exception>
</Docs>
</Member>
Expand Down Expand Up @@ -397,10 +397,10 @@
<paramref name="subkey" /> is <see langword="null" />.</exception>
<exception cref="T:System.ObjectDisposedException">The current <see cref="T:Microsoft.Win32.RegistryKey" /> object is closed (closed keys cannot be accessed).</exception>
<exception cref="T:System.UnauthorizedAccessException">The current <see cref="T:Microsoft.Win32.RegistryKey" /> object cannot be written to; for example, it was not opened as a writable key, or the user does not have the required access rights.</exception>
<exception cref="T:System.IO.IOException">The nesting level exceeds 510.
-or-
<exception cref="T:System.IO.IOException">The nesting level exceeds 510.

-or-

A system error occurred, such as deletion of the key or an attempt to create a key in the <see cref="F:Microsoft.Win32.Registry.LocalMachine" /> root.</exception>
<exception cref="T:System.Security.SecurityException">The user does not have the permissions required to create or open the registry key.</exception>
</Docs>
Expand Down Expand Up @@ -480,10 +480,10 @@
<paramref name="permissionCheck" /> contains an invalid value.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:Microsoft.Win32.RegistryKey" /> on which this method is being invoked is closed (closed keys cannot be accessed).</exception>
<exception cref="T:System.UnauthorizedAccessException">The current <see cref="T:Microsoft.Win32.RegistryKey" /> cannot be written to; for example, it was not opened as a writable key, or the user does not have the necessary access rights.</exception>
<exception cref="T:System.IO.IOException">The nesting level exceeds 510.
-or-
<exception cref="T:System.IO.IOException">The nesting level exceeds 510.

-or-

A system error occurred, such as deletion of the key, or an attempt to create a key in the <see cref="F:Microsoft.Win32.Registry.LocalMachine" /> root.</exception>
</Docs>
</Member>
Expand Down Expand Up @@ -547,10 +547,10 @@
<paramref name="options" /> does not specify a valid Option</exception>
<exception cref="T:System.Security.SecurityException">The user does not have the permissions required to create or open the registry key.</exception>
<exception cref="T:System.UnauthorizedAccessException">The current <see cref="T:Microsoft.Win32.RegistryKey" /> cannot be written to; for example, it was not opened as a writable key, or the user does not have the necessary access rights.</exception>
<exception cref="T:System.IO.IOException">The nesting level exceeds 510.
-or-
<exception cref="T:System.IO.IOException">The nesting level exceeds 510.

-or-

A system error occurred, such as deletion of the key, or an attempt to create a key in the <see cref="F:Microsoft.Win32.Registry.LocalMachine" /> root.</exception>
</Docs>
</Member>
Expand Down Expand Up @@ -614,10 +614,10 @@
<paramref name="subkey" /> is <see langword="null" />.</exception>
<exception cref="T:System.ObjectDisposedException">The current <see cref="T:Microsoft.Win32.RegistryKey" /> object is closed. Closed keys cannot be accessed.</exception>
<exception cref="T:System.UnauthorizedAccessException">The current <see cref="T:Microsoft.Win32.RegistryKey" /> object cannot be written to; for example, it was not opened as a writable key, or the user does not have the required access rights.</exception>
<exception cref="T:System.IO.IOException">The nesting level exceeds 510.
-or-
<exception cref="T:System.IO.IOException">The nesting level exceeds 510.

-or-

A system error occurred, such as deletion of the key or an attempt to create a key in the <see cref="F:Microsoft.Win32.Registry.LocalMachine" /> root.</exception>
<exception cref="T:System.Security.SecurityException">The user does not have the permissions required to create or open the registry key.</exception>
</Docs>
Expand Down Expand Up @@ -837,10 +837,10 @@
<altmember cref="P:Microsoft.Win32.RegistryKey.SubKeyCount" />
<exception cref="T:System.ArgumentNullException">
<paramref name="subkey" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">Deletion of a root hive is attempted.
-or-
<exception cref="T:System.ArgumentException">Deletion of a root hive is attempted.

-or-

<paramref name="subkey" /> does not specify a valid registry subkey.</exception>
<exception cref="T:System.IO.IOException">An I/O error has occurred.</exception>
<exception cref="T:System.Security.SecurityException">The user does not have the permissions required to delete the key.</exception>
Expand Down Expand Up @@ -886,10 +886,10 @@
<param name="throwOnMissingSubKey">Indicates whether an exception should be raised if the specified subkey cannot be found. If this argument is <see langword="true" /> and the specified subkey does not exist, an exception is raised. If this argument is <see langword="false" /> and the specified subkey does not exist, no action is taken.</param>
<summary>Deletes the specified subkey and any child subkeys recursively, and specifies whether an exception is raised if the subkey is not found.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">An attempt was made to delete the root hive of the tree.
-or-
<exception cref="T:System.ArgumentException">An attempt was made to delete the root hive of the tree.

-or-

<paramref name="subkey" /> does not specify a valid registry subkey, and <paramref name="throwOnMissingSubKey" /> is <see langword="true" />.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="subkey" /> is <see langword="null" />.</exception>
Expand Down Expand Up @@ -1021,10 +1021,10 @@
<altmember cref="M:Microsoft.Win32.RegistryKey.GetValueNames" />
<altmember cref="P:Microsoft.Win32.RegistryKey.ValueCount" />
<exception cref="T:System.ArgumentException">
<paramref name="name" /> is not a valid reference to a value and <paramref name="throwOnMissingValue" /> is <see langword="true" />.
-or-
<paramref name="name" /> is not a valid reference to a value and <paramref name="throwOnMissingValue" /> is <see langword="true" />.

-or-

<paramref name="name" /> is <see langword="null" />.</exception>
<exception cref="T:System.Security.SecurityException">The user does not have the permissions required to delete the value.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:Microsoft.Win32.RegistryKey" /> being manipulated is closed (closed keys cannot be accessed).</exception>
Expand Down Expand Up @@ -1745,13 +1745,11 @@
<altmember cref="T:Microsoft.Win32.RegistryValueKind" />
<exception cref="T:System.Security.SecurityException">The user does not have the permissions required to read from the registry key.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:Microsoft.Win32.RegistryKey" /> that contains the specified value is closed (closed keys cannot be accessed).</exception>
<exception cref="T:System.IO.IOException">The subkey that contains the specified value does not exist.

-or-

The name/value pair specified by <paramref name="name" /> does not exist.

This exception is not thrown on Windows 95, Windows 98, or Windows Millennium Edition.</exception>
<exception cref="T:System.IO.IOException">The subkey that contains the specified value does not exist.

-or-

The name/value pair specified by <paramref name="name" /> does not exist.</exception>
<exception cref="T:System.UnauthorizedAccessException">The user does not have the necessary registry rights.</exception>
</Docs>
</Member>
Expand Down Expand Up @@ -2480,10 +2478,10 @@
<paramref name="permissionCheck" /> contains an invalid value.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:Microsoft.Win32.RegistryKey" /> is closed (closed keys cannot be accessed).</exception>
<exception cref="T:System.Security.SecurityException">
<paramref name="rights" /> includes invalid registry rights values.
-or-
<paramref name="rights" /> includes invalid registry rights values.

-or-

The user does not have the requested permissions.</exception>
</Docs>
</Member>
Expand Down Expand Up @@ -2644,13 +2642,8 @@
<exception cref="T:System.ArgumentException">
<paramref name="value" /> is an unsupported data type.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:Microsoft.Win32.RegistryKey" /> that contains the specified value is closed (closed keys cannot be accessed).</exception>
<exception cref="T:System.UnauthorizedAccessException">The <see cref="T:Microsoft.Win32.RegistryKey" /> is read-only, and cannot be written to; for example, the key has not been opened with write access.

-or-

The <see cref="T:Microsoft.Win32.RegistryKey" /> object represents a root-level node, and the operating system is Windows Millennium Edition or Windows 98.</exception>
<exception cref="T:System.UnauthorizedAccessException">The <see cref="T:Microsoft.Win32.RegistryKey" /> is read-only, and cannot be written to; for example, the key has not been opened with write access.</exception>
<exception cref="T:System.Security.SecurityException">The user does not have the permissions required to create or modify registry keys.</exception>
<exception cref="T:System.IO.IOException">The <see cref="T:Microsoft.Win32.RegistryKey" /> object represents a root-level node, and the operating system is Windows 2000, Windows XP, or Windows Server 2003.</exception>
</Docs>
</Member>
<Member MemberName="SetValue">
Expand Down Expand Up @@ -2742,13 +2735,8 @@
<paramref name="value" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The type of <paramref name="value" /> did not match the registry data type specified by <paramref name="valueKind" />, therefore the data could not be converted properly.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:Microsoft.Win32.RegistryKey" /> that contains the specified value is closed (closed keys cannot be accessed).</exception>
<exception cref="T:System.UnauthorizedAccessException">The <see cref="T:Microsoft.Win32.RegistryKey" /> is read-only, and cannot be written to; for example, the key has not been opened with write access.

-or-

The <see cref="T:Microsoft.Win32.RegistryKey" /> object represents a root-level node, and the operating system is Windows Millennium Edition or Windows 98.</exception>
<exception cref="T:System.UnauthorizedAccessException">The <see cref="T:Microsoft.Win32.RegistryKey" /> is read-only, and cannot be written to; for example, the key has not been opened with write access.</exception>
<exception cref="T:System.Security.SecurityException">The user does not have the permissions required to create or modify registry keys.</exception>
<exception cref="T:System.IO.IOException">The <see cref="T:Microsoft.Win32.RegistryKey" /> object represents a root-level node, and the operating system is Windows 2000, Windows XP, or Windows Server 2003.</exception>
</Docs>
</Member>
<Member MemberName="SubKeyCount">
Expand Down Expand Up @@ -2952,10 +2940,10 @@
</ReturnValue>
<Docs>
<summary>Gets the view that was used to create the registry key.</summary>
<value>The view that was used to create the registry key.
-or-
<value>The view that was used to create the registry key.

-or-

<see cref="F:Microsoft.Win32.RegistryView.Default" />, if no view was used.</value>
<remarks>
<format type="text/markdown"><![CDATA[
Expand Down
9 changes: 1 addition & 8 deletions xml/System.Diagnostics.PerformanceData/CounterType.xml
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,7 @@
</Base>
<Docs>
<summary>Defines the possible types of counters. Each counter is assigned a counter type. The counter type determines how the counter data is calculated, averaged, and displayed.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
For details on the types listed in this enumeration, see the Counter Types section of the [Windows Server 2003 Deployment Kit](https://go.microsoft.com/FWLink/?LinkId=84422).

]]></format>
</remarks>
<remarks>To be added.</remarks>
Comment thread
gewarren marked this conversation as resolved.
</Docs>
<Members>
<Member MemberName="AverageBase">
Expand Down
Loading
Loading