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

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="RegistryValueKind" FullName="Microsoft.Win32.RegistryValueKind">
   3   <TypeSignature Language="C#" Value="public enum RegistryValueKind" />
   4   <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed RegistryValueKind extends System.Enum" />
   5   <AssemblyInfo>
   6     <AssemblyName>mscorlib</AssemblyName>
   7     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   8     <AssemblyVersion>4.0.0.0</AssemblyVersion>
   9   </AssemblyInfo>
  10   <Base>
  11     <BaseTypeName>System.Enum</BaseTypeName>
  12   </Base>
  13   <Attributes>
  14     <Attribute>
  15       <AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
  16     </Attribute>
  17   </Attributes>
  18   <Docs>
  19     <since version=".NET 2.0" />
  20     <remarks>
  21       <attribution license="cc4" from="Microsoft" modified="false" />
  22       <para>The <see cref="T:Microsoft.Win32.RegistryValueKind" /> enumeration defines the set of supported registry data types and the value that is used for unsupported types (<see cref="F:Microsoft.Win32.RegistryValueKind.Unknown" />). Starting in the net_v40_long, you can specify not to use a data type with the <see cref="F:Microsoft.Win32.RegistryValueKind.None" /> value.</para>
  23       <para>Use the <see cref="M:Microsoft.Win32.RegistryKey.GetValueKind(System.String)" /> method to determine the data type of a registry key value before retrieving the value. When you set a registry key value, use the <see cref="M:Microsoft.Win32.RegistryKey.SetValue(System.String,System.Object,Microsoft.Win32.RegistryValueKind)" /> method to specify the registry data type explicitly.</para>
  24     </remarks>
  25     <summary>
  26       <attribution license="cc4" from="Microsoft" modified="false" />
  27       <para>Specifies the data types to use when storing values in the registry, or identifies the data type of a value in the registry.</para>
  28     </summary>
  29   </Docs>
  30   <Members>
  31     <Member MemberName="Binary">
  32       <MemberSignature Language="C#" Value="Binary" />
  33       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.Win32.RegistryValueKind Binary = int32(3)" />
  34       <MemberType>Field</MemberType>
  35       <AssemblyInfo>
  36         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  37         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  38       </AssemblyInfo>
  39       <ReturnValue>
  40         <ReturnType>Microsoft.Win32.RegistryValueKind</ReturnType>
  41       </ReturnValue>
  42       <Docs>
  43         <since version=".NET 2.0" />
  44         <summary>
  45           <attribution license="cc4" from="Microsoft" modified="false" />
  46           <para>Binary data in any form. This value is equivalent to the Win32 API registry data type REG_BINARY. </para>
  47         </summary>
  48       </Docs>
  49     </Member>
  50     <Member MemberName="DWord">
  51       <MemberSignature Language="C#" Value="DWord" />
  52       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.Win32.RegistryValueKind DWord = int32(4)" />
  53       <MemberType>Field</MemberType>
  54       <AssemblyInfo>
  55         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  56         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  57       </AssemblyInfo>
  58       <ReturnValue>
  59         <ReturnType>Microsoft.Win32.RegistryValueKind</ReturnType>
  60       </ReturnValue>
  61       <Docs>
  62         <since version=".NET 2.0" />
  63         <summary>
  64           <attribution license="cc4" from="Microsoft" modified="false" />
  65           <para>A 32-bit binary number. This value is equivalent to the Win32 API registry data type REG_DWORD.</para>
  66         </summary>
  67       </Docs>
  68     </Member>
  69     <Member MemberName="ExpandString">
  70       <MemberSignature Language="C#" Value="ExpandString" />
  71       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.Win32.RegistryValueKind ExpandString = int32(2)" />
  72       <MemberType>Field</MemberType>
  73       <AssemblyInfo>
  74         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  75         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  76       </AssemblyInfo>
  77       <ReturnValue>
  78         <ReturnType>Microsoft.Win32.RegistryValueKind</ReturnType>
  79       </ReturnValue>
  80       <Docs>
  81         <since version=".NET 2.0" />
  82         <summary>
  83           <attribution license="cc4" from="Microsoft" modified="false" />
  84           <para>A null-terminated string that contains unexpanded references to environment variables, such as %PATH%, that are expanded when the value is retrieved. This value is equivalent to the Win32 API registry data type REG_EXPAND_SZ.</para>
  85         </summary>
  86       </Docs>
  87     </Member>
  88     <Member MemberName="MultiString">
  89       <MemberSignature Language="C#" Value="MultiString" />
  90       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.Win32.RegistryValueKind MultiString = int32(7)" />
  91       <MemberType>Field</MemberType>
  92       <AssemblyInfo>
  93         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  94         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  95       </AssemblyInfo>
  96       <ReturnValue>
  97         <ReturnType>Microsoft.Win32.RegistryValueKind</ReturnType>
  98       </ReturnValue>
  99       <Docs>
 100         <since version=".NET 2.0" />
 101         <summary>
 102           <attribution license="cc4" from="Microsoft" modified="false" />
 103           <para>An array of null-terminated strings, terminated by two null characters. This value is equivalent to the Win32 API registry data type REG_MULTI_SZ.</para>
 104         </summary>
 105       </Docs>
 106     </Member>
 107     <Member MemberName="None">
 108       <MemberSignature Language="C#" Value="None" />
 109       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.Win32.RegistryValueKind None = int32(-1)" />
 110       <MemberType>Field</MemberType>
 111       <AssemblyInfo>
 112         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 113       </AssemblyInfo>
 114       <ReturnValue>
 115         <ReturnType>Microsoft.Win32.RegistryValueKind</ReturnType>
 116       </ReturnValue>
 117       <Docs>
 118         <summary>
 119           <attribution license="cc4" from="Microsoft" modified="false" />
 120           <para>No data type.</para>
 121         </summary>
 122       </Docs>
 123     </Member>
 124     <Member MemberName="QWord">
 125       <MemberSignature Language="C#" Value="QWord" />
 126       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.Win32.RegistryValueKind QWord = int32(11)" />
 127       <MemberType>Field</MemberType>
 128       <AssemblyInfo>
 129         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 130         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 131       </AssemblyInfo>
 132       <ReturnValue>
 133         <ReturnType>Microsoft.Win32.RegistryValueKind</ReturnType>
 134       </ReturnValue>
 135       <Docs>
 136         <since version=".NET 2.0" />
 137         <summary>
 138           <attribution license="cc4" from="Microsoft" modified="false" />
 139           <para>A 64-bit binary number. This value is equivalent to the Win32 API registry data type REG_QWORD.</para>
 140         </summary>
 141       </Docs>
 142     </Member>
 143     <Member MemberName="String">
 144       <MemberSignature Language="C#" Value="String" />
 145       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.Win32.RegistryValueKind String = int32(1)" />
 146       <MemberType>Field</MemberType>
 147       <AssemblyInfo>
 148         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 149         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 150       </AssemblyInfo>
 151       <ReturnValue>
 152         <ReturnType>Microsoft.Win32.RegistryValueKind</ReturnType>
 153       </ReturnValue>
 154       <Docs>
 155         <since version=".NET 2.0" />
 156         <summary>
 157           <attribution license="cc4" from="Microsoft" modified="false" />
 158           <para>A null-terminated string. This value is equivalent to the Win32 API registry data type REG_SZ.</para>
 159         </summary>
 160       </Docs>
 161     </Member>
 162     <Member MemberName="Unknown">
 163       <MemberSignature Language="C#" Value="Unknown" />
 164       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.Win32.RegistryValueKind Unknown = int32(0)" />
 165       <MemberType>Field</MemberType>
 166       <AssemblyInfo>
 167         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 168         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 169       </AssemblyInfo>
 170       <ReturnValue>
 171         <ReturnType>Microsoft.Win32.RegistryValueKind</ReturnType>
 172       </ReturnValue>
 173       <Docs>
 174         <since version=".NET 2.0" />
 175         <summary>
 176           <attribution license="cc4" from="Microsoft" modified="false" />
 177           <para>An unsupported registry data type. For example, the Microsoft Win32 API registry data type REG_RESOURCE_LIST is unsupported. Use this value to specify that the <see cref="M:Microsoft.Win32.RegistryKey.SetValue(System.String,System.Object)" /> method should determine the appropriate registry data type when storing a name/value pair.</para>
 178         </summary>
 179       </Docs>
 180     </Member>
 181   </Members>
 182 </Type>