mcs/class/corlib/Documentation/en/Microsoft.Win32/RegistryKeyPermissionCheck.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="RegistryKeyPermissionCheck" FullName="Microsoft.Win32.RegistryKeyPermissionCheck">
   3   <TypeSignature Language="C#" Value="public enum RegistryKeyPermissionCheck" />
   4   <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed RegistryKeyPermissionCheck extends System.Enum" />
   5   <AssemblyInfo>
   6     <AssemblyName>mscorlib</AssemblyName>
   7     <AssemblyVersions>
   8       <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   9       <AssemblyVersion>2.0.0.0</AssemblyVersion>
  10     </AssemblyVersions>
  11     <AssemblyVersion>2.0.0.0</AssemblyVersion>
  12     <AssemblyVersion>4.0.0.0</AssemblyVersion>
  13   </AssemblyInfo>
  14   <Base>
  15     <BaseTypeName>System.Enum</BaseTypeName>
  16   </Base>
  17   <Docs>
  18     <remarks>
  19       <attribution license="cc4" from="Microsoft" modified="false" />
  20       <para>When an application saves or retrieves a large number of registry settings from a set of subkeys, numerous redundant security checks are performed. This enumeration specifies when security checks on a key are to be omitted.</para>
  21       <para>The following table shows when security checks are performed, based on the way the parent key and the current key are opened.</para>
  22       <list type="table">
  23         <listheader>
  24           <item>
  25             <term>
  26               <para>Parent key opened with</para>
  27             </term>
  28             <description>
  29               <para>Current key opened with</para>
  30             </description>
  31             <description>
  32               <para>Result</para>
  33             </description>
  34           </item>
  35         </listheader>
  36         <item>
  37           <term>
  38             <para>
  39               <see cref="F:Microsoft.Win32.RegistryKeyPermissionCheck.Default" /> </para>
  40           </term>
  41           <description>
  42             <para>
  43               <see cref="F:Microsoft.Win32.RegistryKeyPermissionCheck.Default" /> </para>
  44           </description>
  45           <description>
  46             <para>A security check is performed when accessing any value in the current key, or when attempting to access a subkey. This is the behavior in the .NET Framework versions 1.0 and 1.1.</para>
  47           </description>
  48         </item>
  49         <item>
  50           <term>
  51             <para>
  52               <see cref="F:Microsoft.Win32.RegistryKeyPermissionCheck.Default" /> </para>
  53           </term>
  54           <description>
  55             <para>
  56               <see cref="F:Microsoft.Win32.RegistryKeyPermissionCheck.ReadSubTree" /> </para>
  57           </description>
  58           <description>
  59             <para>A security check is performed when trying to open the current key.</para>
  60           </description>
  61         </item>
  62         <item>
  63           <term>
  64             <para>
  65               <see cref="F:Microsoft.Win32.RegistryKeyPermissionCheck.Default" /> </para>
  66           </term>
  67           <description>
  68             <para>
  69               <see cref="F:Microsoft.Win32.RegistryKeyPermissionCheck.ReadWriteSubTree" /> </para>
  70           </description>
  71           <description>
  72             <para>A security check is performed when trying to open the current key.</para>
  73           </description>
  74         </item>
  75         <item>
  76           <term>
  77             <para>
  78               <see cref="F:Microsoft.Win32.RegistryKeyPermissionCheck.ReadSubTree" /> </para>
  79           </term>
  80           <description>
  81             <para>
  82               <see cref="F:Microsoft.Win32.RegistryKeyPermissionCheck.Default" /> or <see cref="F:Microsoft.Win32.RegistryKeyPermissionCheck.ReadSubTree" /> </para>
  83           </description>
  84           <description>
  85             <para>No security checks are performed when opening the current key or its values.</para>
  86           </description>
  87         </item>
  88         <item>
  89           <term>
  90             <para>
  91               <see cref="F:Microsoft.Win32.RegistryKeyPermissionCheck.ReadSubTree" /> </para>
  92           </term>
  93           <description>
  94             <para>
  95               <see cref="F:Microsoft.Win32.RegistryKeyPermissionCheck.ReadWriteSubTree" /> </para>
  96           </description>
  97           <description>
  98             <para>A security check is performed when trying to open the current key.</para>
  99           </description>
 100         </item>
 101         <item>
 102           <term>
 103             <para>
 104               <see cref="F:Microsoft.Win32.RegistryKeyPermissionCheck.ReadWriteSubTree" /> </para>
 105           </term>
 106           <description>
 107             <para>Any </para>
 108           </description>
 109           <description>
 110             <para>No security checks are performed when opening the current key or its values.</para>
 111           </description>
 112         </item>
 113       </list>
 114     </remarks>
 115     <summary>
 116       <attribution license="cc4" from="Microsoft" modified="false" />
 117       <para>Specifies whether security checks are performed when opening registry keys and accessing their name/value pairs.</para>
 118     </summary>
 119   </Docs>
 120   <Members>
 121     <Member MemberName="Default">
 122       <MemberSignature Language="C#" Value="Default" />
 123       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.Win32.RegistryKeyPermissionCheck Default = int32(0)" />
 124       <MemberType>Field</MemberType>
 125       <AssemblyInfo>
 126         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 127         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 128         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 129       </AssemblyInfo>
 130       <ReturnValue>
 131         <ReturnType>Microsoft.Win32.RegistryKeyPermissionCheck</ReturnType>
 132       </ReturnValue>
 133       <Docs>
 134         <summary>
 135           <attribution license="cc4" from="Microsoft" modified="false" />
 136           <para>The registry key inherits the mode of its parent. Security checks are performed when trying to access subkeys or values, unless the parent was opened with <see cref="F:Microsoft.Win32.RegistryKeyPermissionCheck.ReadSubTree" /> or <see cref="F:Microsoft.Win32.RegistryKeyPermissionCheck.ReadWriteSubTree" /> mode.</para>
 137         </summary>
 138       </Docs>
 139     </Member>
 140     <Member MemberName="ReadSubTree">
 141       <MemberSignature Language="C#" Value="ReadSubTree" />
 142       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.Win32.RegistryKeyPermissionCheck ReadSubTree = int32(1)" />
 143       <MemberType>Field</MemberType>
 144       <AssemblyInfo>
 145         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 146         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 147         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 148       </AssemblyInfo>
 149       <ReturnValue>
 150         <ReturnType>Microsoft.Win32.RegistryKeyPermissionCheck</ReturnType>
 151       </ReturnValue>
 152       <Docs>
 153         <summary>
 154           <attribution license="cc4" from="Microsoft" modified="false" />
 155           <para>Security checks are not performed when accessing subkeys or values. A security check is performed when trying to open the current key, unless the parent was opened with <see cref="F:Microsoft.Win32.RegistryKeyPermissionCheck.ReadSubTree" /> or <see cref="F:Microsoft.Win32.RegistryKeyPermissionCheck.ReadWriteSubTree" />.</para>
 156         </summary>
 157       </Docs>
 158     </Member>
 159     <Member MemberName="ReadWriteSubTree">
 160       <MemberSignature Language="C#" Value="ReadWriteSubTree" />
 161       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.Win32.RegistryKeyPermissionCheck ReadWriteSubTree = int32(2)" />
 162       <MemberType>Field</MemberType>
 163       <AssemblyInfo>
 164         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 165         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 166         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 167       </AssemblyInfo>
 168       <ReturnValue>
 169         <ReturnType>Microsoft.Win32.RegistryKeyPermissionCheck</ReturnType>
 170       </ReturnValue>
 171       <Docs>
 172         <summary>
 173           <attribution license="cc4" from="Microsoft" modified="false" />
 174           <para>Security checks are not performed when accessing subkeys or values. A security check is performed when trying to open the current key, unless the parent was opened with <see cref="F:Microsoft.Win32.RegistryKeyPermissionCheck.ReadWriteSubTree" />.</para>
 175         </summary>
 176       </Docs>
 177     </Member>
 178   </Members>
 179 </Type>