mcs/class/System.Data/Documentation/en/System.Data.Common/DBDataPermission.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="DBDataPermission" FullName="System.Data.Common.DBDataPermission">
   3   <TypeSignature Language="C#" Maintainer="auto" Value="public abstract class DBDataPermission : System.Security.CodeAccessPermission, System.Security.Permissions.IUnrestrictedPermission" />
   4   <AssemblyInfo>
   5     <AssemblyName>System.Data</AssemblyName>
   6     <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
   7     <AssemblyVersion>1.0.3300.0</AssemblyVersion>
   8     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   9     <AssemblyVersion>2.0.0.0</AssemblyVersion>
  10   </AssemblyInfo>
  11   <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
  12   <Base>
  13     <BaseTypeName>System.Security.CodeAccessPermission</BaseTypeName>
  14   </Base>
  15   <Interfaces>
  16     <Interface>
  17       <InterfaceName>System.Security.Permissions.IUnrestrictedPermission</InterfaceName>
  18     </Interface>
  19   </Interfaces>
  20   <Docs>
  21     <remarks>To be added</remarks>
  22     <summary>
  23       <attribution license="cc4" from="Microsoft" modified="false" />
  24       <para>Enables a .NET Framework data provider to help ensure that a user has a security level adequate for accessing data.</para>
  25     </summary>
  26   </Docs>
  27   <Members>
  28     <Member MemberName=".ctor">
  29       <MemberSignature Language="C#" Value="protected DBDataPermission ();" />
  30       <MemberType>Constructor</MemberType>
  31       <ReturnValue />
  32       <Parameters />
  33       <Docs>
  34         <remarks>To be added</remarks>
  35         <summary>
  36           <attribution license="cc4" from="Microsoft" modified="false" />
  37           <para>Initializes a new instance of a DBDataPermission class.</para>
  38         </summary>
  39       </Docs>
  40       <AssemblyInfo>
  41         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  42         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  43       </AssemblyInfo>
  44       <Attributes>
  45         <Attribute>
  46           <AttributeName>System.Obsolete("use DBDataPermission (PermissionState.None)", true)</AttributeName>
  47         </Attribute>
  48       </Attributes>
  49     </Member>
  50     <Member MemberName=".ctor">
  51       <MemberSignature Language="C#" Value="protected DBDataPermission (System.Data.Common.DBDataPermission permission);" />
  52       <MemberType>Constructor</MemberType>
  53       <AssemblyInfo>
  54         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  55         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  56       </AssemblyInfo>
  57       <Parameters>
  58         <Parameter Name="permission" Type="System.Data.Common.DBDataPermission" />
  59       </Parameters>
  60       <Docs>
  61         <remarks>To be added.</remarks>
  62         <summary>
  63           <attribution license="cc4" from="Microsoft" modified="false" />
  64           <para>Initializes a new instance of a DBDataPermission class using an existing DBDataPermission.</para>
  65         </summary>
  66         <param name="permission">
  67           <attribution license="cc4" from="Microsoft" modified="false" />An existing DBDataPermission used to create a new DBDataPermission. </param>
  68       </Docs>
  69     </Member>
  70     <Member MemberName=".ctor">
  71       <MemberSignature Language="C#" Value="protected DBDataPermission (System.Data.Common.DBDataPermissionAttribute permissionAttribute);" />
  72       <MemberType>Constructor</MemberType>
  73       <AssemblyInfo>
  74         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  75         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  76       </AssemblyInfo>
  77       <Parameters>
  78         <Parameter Name="permissionAttribute" Type="System.Data.Common.DBDataPermissionAttribute" />
  79       </Parameters>
  80       <Docs>
  81         <remarks>To be added.</remarks>
  82         <summary>
  83           <attribution license="cc4" from="Microsoft" modified="false" />
  84           <para>Initializes a new instance of a DBDataPermission class with the specified DBDataPermissionAttribute.</para>
  85         </summary>
  86         <param name="permissionAttribute">
  87           <attribution license="cc4" from="Microsoft" modified="false" />A security action associated with a custom security attribute. </param>
  88       </Docs>
  89     </Member>
  90     <Member MemberName=".ctor">
  91       <MemberSignature Language="C#" Value="protected DBDataPermission (System.Security.Permissions.PermissionState state);" />
  92       <MemberType>Constructor</MemberType>
  93       <ReturnValue />
  94       <Parameters>
  95         <Parameter Name="state" Type="System.Security.Permissions.PermissionState" />
  96       </Parameters>
  97       <Docs>
  98         <remarks>To be added</remarks>
  99         <summary>
 100           <attribution license="cc4" from="Microsoft" modified="false" />
 101           <para>Initializes a new instance of a DBDataPermission class with the specified <see cref="T:System.Security.Permissions.PermissionState" /> value.</para>
 102         </summary>
 103         <param name="state">
 104           <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Security.Permissions.PermissionState" /> values. </param>
 105       </Docs>
 106       <AssemblyInfo>
 107         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 108         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 109       </AssemblyInfo>
 110     </Member>
 111     <Member MemberName=".ctor">
 112       <MemberSignature Language="C#" Value="protected DBDataPermission (System.Security.Permissions.PermissionState state, bool allowBlankPassword);" />
 113       <MemberType>Constructor</MemberType>
 114       <ReturnValue />
 115       <Parameters>
 116         <Parameter Name="state" Type="System.Security.Permissions.PermissionState" />
 117         <Parameter Name="allowBlankPassword" Type="System.Boolean" />
 118       </Parameters>
 119       <Docs>
 120         <remarks>
 121           <attribution license="cc4" from="Microsoft" modified="false" />
 122           <para>The <see cref="T:System.Security.Permissions.PermissionState" /> enumeration takes precedence over the <see cref="P:System.Data.Common.DBDataPermission.AllowBlankPassword" /> property. Therefore, if you set <see cref="P:System.Data.Common.DBDataPermission.AllowBlankPassword" /> to false, you must also set <see cref="T:System.Security.Permissions.PermissionState" /> to None to prevent a user from making a connection using a blank password.</para>
 123         </remarks>
 124         <summary>
 125           <attribution license="cc4" from="Microsoft" modified="false" />
 126           <para>Initializes a new instance of a DBDataPermission class with the specified <see cref="T:System.Security.Permissions.PermissionState" /> value, and a value indicating whether a blank password is allowed.</para>
 127         </summary>
 128         <param name="state">
 129           <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Security.Permissions.PermissionState" /> values. </param>
 130         <param name="allowBlankPassword">
 131           <attribution license="cc4" from="Microsoft" modified="false" />Indicates whether a blank password is allowed. </param>
 132       </Docs>
 133       <AssemblyInfo>
 134         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 135         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 136       </AssemblyInfo>
 137       <Attributes>
 138         <Attribute>
 139           <AttributeName>System.Obsolete("use DBDataPermission (PermissionState.None)", true)</AttributeName>
 140         </Attribute>
 141       </Attributes>
 142     </Member>
 143     <Member MemberName="Add">
 144       <MemberSignature Language="C#" Value="public virtual void Add (string connectionString, string restrictions, System.Data.KeyRestrictionBehavior behavior);" />
 145       <MemberType>Method</MemberType>
 146       <AssemblyInfo>
 147         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 148         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 149       </AssemblyInfo>
 150       <ReturnValue>
 151         <ReturnType>System.Void</ReturnType>
 152       </ReturnValue>
 153       <Parameters>
 154         <Parameter Name="connectionString" Type="System.String" />
 155         <Parameter Name="restrictions" Type="System.String" />
 156         <Parameter Name="behavior" Type="System.Data.KeyRestrictionBehavior" />
 157       </Parameters>
 158       <Docs>
 159         <remarks>
 160           <attribution license="cc4" from="Microsoft" modified="false" />
 161           <para>This method can be useful when implementing:</para>
 162           <list type="bullet">
 163             <item>
 164               <para>A .NET framework data provider.</para>
 165             </item>
 166             <item>
 167               <para>An API that must assert for data access permission.</para>
 168             </item>
 169             <item>
 170               <para>An administrative tool or installation program that must modify security policy.</para>
 171             </item>
 172             <item>
 173               <para>When more than one rule is specified, the more restrictive rule is selected.</para>
 174             </item>
 175           </list>
 176         </remarks>
 177         <summary>
 178           <attribution license="cc4" from="Microsoft" modified="false" />
 179           <para>Adds access for the specified connection string to the existing state of the DBDataPermission. </para>
 180         </summary>
 181         <param name="connectionString">
 182           <attribution license="cc4" from="Microsoft" modified="false" />A permitted connection string.</param>
 183         <param name="restrictions">
 184           <attribution license="cc4" from="Microsoft" modified="false" />String that identifies connection string parameters that are allowed or disallowed.</param>
 185         <param name="behavior">
 186           <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Data.KeyRestrictionBehavior" /> properties.</param>
 187       </Docs>
 188     </Member>
 189     <Member MemberName="AllowBlankPassword">
 190       <MemberSignature Language="C#" Value="public bool AllowBlankPassword { set; get; }" />
 191       <MemberType>Property</MemberType>
 192       <ReturnValue>
 193         <ReturnType>System.Boolean</ReturnType>
 194       </ReturnValue>
 195       <Parameters>
 196       </Parameters>
 197       <Docs>
 198         <value>To be added: an object of type 'bool'</value>
 199         <remarks>
 200           <attribution license="cc4" from="Microsoft" modified="false" />
 201           <para>The <see cref="T:System.Security.Permissions.PermissionState" /> enumeration takes precedence over the <see cref="P:System.Data.Common.DBDataPermission.AllowBlankPassword" /> property. Therefore, if you set <see cref="P:System.Data.Common.DBDataPermission.AllowBlankPassword" /> to false, you must also set <see cref="T:System.Security.Permissions.PermissionState" /> to None to prevent a user from making a connection using a blank password.</para>
 202         </remarks>
 203         <summary>
 204           <attribution license="cc4" from="Microsoft" modified="false" />
 205           <para>Gets a value indicating whether a blank password is allowed.</para>
 206         </summary>
 207       </Docs>
 208       <AssemblyInfo>
 209         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 210         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 211       </AssemblyInfo>
 212     </Member>
 213     <Member MemberName="Clear">
 214       <MemberSignature Language="C#" Value="protected void Clear ();" />
 215       <MemberType>Method</MemberType>
 216       <AssemblyInfo>
 217         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 218         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 219       </AssemblyInfo>
 220       <ReturnValue>
 221         <ReturnType>System.Void</ReturnType>
 222       </ReturnValue>
 223       <Parameters />
 224       <Docs>
 225         <remarks>To be added.</remarks>
 226         <summary>
 227           <attribution license="cc4" from="Microsoft" modified="false" />
 228           <para>Removes all permissions that were previous added using the <see cref="M:System.Data.Common.DBDataPermission.Add(System.String,System.String,System.Data.KeyRestrictionBehavior)" /> method.</para>
 229         </summary>
 230       </Docs>
 231     </Member>
 232     <Member MemberName="Copy">
 233       <MemberSignature Language="C#" Value="public override System.Security.IPermission Copy ();" />
 234       <MemberType>Method</MemberType>
 235       <ReturnValue>
 236         <ReturnType>System.Security.IPermission</ReturnType>
 237       </ReturnValue>
 238       <Parameters />
 239       <Docs>
 240         <returns>To be added: an object of type 'Security.IPermission'</returns>
 241         <remarks>
 242           <attribution license="cc4" from="Microsoft" modified="false" />
 243           <para>A copy of a permission object represents the same access to resources as the original permission object.</para>
 244         </remarks>
 245         <summary>
 246           <attribution license="cc4" from="Microsoft" modified="false" />
 247           <para>Creates and returns an identical copy of the current permission object.</para>
 248         </summary>
 249       </Docs>
 250       <AssemblyInfo>
 251         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 252         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 253       </AssemblyInfo>
 254     </Member>
 255     <Member MemberName="CreateInstance">
 256       <MemberSignature Language="C#" Value="protected virtual System.Data.Common.DBDataPermission CreateInstance ();" />
 257       <MemberType>Method</MemberType>
 258       <ReturnValue>
 259         <ReturnType>System.Data.Common.DBDataPermission</ReturnType>
 260       </ReturnValue>
 261       <Parameters />
 262       <Docs>
 263         <returns>To be added: an object of type 'DBDataPermission'</returns>
 264         <remarks>To be added</remarks>
 265         <summary>
 266           <attribution license="cc4" from="Microsoft" modified="false" />
 267           <para>Creates a new instance of the DBDataPermission class.</para>
 268         </summary>
 269       </Docs>
 270       <AssemblyInfo>
 271         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 272         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 273       </AssemblyInfo>
 274     </Member>
 275     <Member MemberName="FromXml">
 276       <MemberSignature Language="C#" Value="public override void FromXml (System.Security.SecurityElement securityElement);" />
 277       <MemberType>Method</MemberType>
 278       <ReturnValue>
 279         <ReturnType>System.Void</ReturnType>
 280       </ReturnValue>
 281       <Parameters>
 282         <Parameter Name="securityElement" Type="System.Security.SecurityElement" />
 283       </Parameters>
 284       <Docs>
 285         <remarks>
 286           <attribution license="cc4" from="Microsoft" modified="false" />
 287           <para>Custom code that extends security objects needs to implement the ToXml and FromXml methods to make the objects security encodable.</para>
 288         </remarks>
 289         <summary>
 290           <attribution license="cc4" from="Microsoft" modified="false" />
 291           <para>Reconstructs a security object with a specified state from an XML encoding.</para>
 292         </summary>
 293         <param name="securityElement">
 294           <attribution license="cc4" from="Microsoft" modified="false" />The XML encoding to use to reconstruct the security object. </param>
 295       </Docs>
 296       <AssemblyInfo>
 297         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 298         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 299       </AssemblyInfo>
 300     </Member>
 301     <Member MemberName="Intersect">
 302       <MemberSignature Language="C#" Value="public override System.Security.IPermission Intersect (System.Security.IPermission target);" />
 303       <MemberType>Method</MemberType>
 304       <ReturnValue>
 305         <ReturnType>System.Security.IPermission</ReturnType>
 306       </ReturnValue>
 307       <Parameters>
 308         <Parameter Name="target" Type="System.Security.IPermission" />
 309       </Parameters>
 310       <Docs>
 311         <returns>To be added: an object of type 'Security.IPermission'</returns>
 312         <remarks>
 313           <attribution license="cc4" from="Microsoft" modified="false" />
 314           <para>The intersection of two permissions is a permission that describes the set of operations they both describe. Only a demand that passes both original permissions will pass the intersection.</para>
 315         </remarks>
 316         <summary>
 317           <attribution license="cc4" from="Microsoft" modified="false" />
 318           <para>Returns a new permission object representing the intersection of the current permission object and the specified permission object.</para>
 319         </summary>
 320         <param name="target">
 321           <attribution license="cc4" from="Microsoft" modified="false" />A permission object to intersect with the current permission object. It must be of the same type as the current permission object. </param>
 322       </Docs>
 323       <AssemblyInfo>
 324         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 325         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 326       </AssemblyInfo>
 327     </Member>
 328     <Member MemberName="IsSubsetOf">
 329       <MemberSignature Language="C#" Value="public override bool IsSubsetOf (System.Security.IPermission target);" />
 330       <MemberType>Method</MemberType>
 331       <ReturnValue>
 332         <ReturnType>System.Boolean</ReturnType>
 333       </ReturnValue>
 334       <Parameters>
 335         <Parameter Name="target" Type="System.Security.IPermission" />
 336       </Parameters>
 337       <Docs>
 338         <returns>To be added: an object of type 'bool'</returns>
 339         <remarks>
 340           <attribution license="cc4" from="Microsoft" modified="false" />
 341           <para>The current permission object is a subset of the specified permission object if the current permission object specifies a set of operations that is wholly contained by the specified permission object. For example, a permission that represents access to C:\example.txt is a subset of a permission that represents access to C:\. If this method returns true, the current permission object represents no more access to the protected resource than does the specified permission object.</para>
 342         </remarks>
 343         <summary>
 344           <attribution license="cc4" from="Microsoft" modified="false" />
 345           <para>Returns a value indicating whether the current permission object is a subset of the specified permission object.</para>
 346         </summary>
 347         <param name="target">
 348           <attribution license="cc4" from="Microsoft" modified="false" />A permission object that is to be tested for the subset relationship. This object must be of the same type as the current permission object. </param>
 349       </Docs>
 350       <AssemblyInfo>
 351         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 352         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 353       </AssemblyInfo>
 354     </Member>
 355     <Member MemberName="IsUnrestricted">
 356       <MemberSignature Language="C#" Value="public bool IsUnrestricted ();" />
 357       <MemberType>Method</MemberType>
 358       <ReturnValue>
 359         <ReturnType>System.Boolean</ReturnType>
 360       </ReturnValue>
 361       <Parameters />
 362       <Docs>
 363         <returns>To be added: an object of type 'bool'</returns>
 364         <remarks>To be added</remarks>
 365         <summary>
 366           <attribution license="cc4" from="Microsoft" modified="false" />
 367           <para>Returns a value indicating whether the permission can be represented as unrestricted without any knowledge of the permission semantics.</para>
 368         </summary>
 369       </Docs>
 370       <AssemblyInfo>
 371         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 372         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 373       </AssemblyInfo>
 374     </Member>
 375     <Member MemberName="ToXml">
 376       <MemberSignature Language="C#" Value="public override System.Security.SecurityElement ToXml ();" />
 377       <MemberType>Method</MemberType>
 378       <ReturnValue>
 379         <ReturnType>System.Security.SecurityElement</ReturnType>
 380       </ReturnValue>
 381       <Parameters />
 382       <Docs>
 383         <returns>To be added: an object of type 'Security.SecurityElement'</returns>
 384         <remarks>
 385           <attribution license="cc4" from="Microsoft" modified="false" />
 386           <para>Custom code that extends security objects must implement the <see cref="M:System.Data.Common.DBDataPermission.ToXml" /> and <see cref="M:System.Data.Common.DBDataPermission.FromXml(System.Security.SecurityElement)" /> methods to make the objects security encodable.</para>
 387         </remarks>
 388         <summary>
 389           <attribution license="cc4" from="Microsoft" modified="false" />
 390           <para>Creates an XML encoding of the security object and its current state.</para>
 391         </summary>
 392       </Docs>
 393       <AssemblyInfo>
 394         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 395         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 396       </AssemblyInfo>
 397     </Member>
 398     <Member MemberName="Union">
 399       <MemberSignature Language="C#" Value="public override System.Security.IPermission Union (System.Security.IPermission target);" />
 400       <MemberType>Method</MemberType>
 401       <ReturnValue>
 402         <ReturnType>System.Security.IPermission</ReturnType>
 403       </ReturnValue>
 404       <Parameters>
 405         <Parameter Name="target" Type="System.Security.IPermission" />
 406       </Parameters>
 407       <Docs>
 408         <returns>To be added: an object of type 'Security.IPermission'</returns>
 409         <remarks>
 410           <attribution license="cc4" from="Microsoft" modified="false" />
 411           <para>The result of a call to <see cref="M:System.Data.Common.DBDataPermission.Union(System.Security.IPermission)" /> is a permission that represents all the operations permitted by both the current permission object and the specified permission object. Any demand that passes either permission passes their union.</para>
 412         </remarks>
 413         <summary>
 414           <attribution license="cc4" from="Microsoft" modified="false" />
 415           <para>Returns a new permission object that is the union of the current and specified permission objects.</para>
 416         </summary>
 417         <param name="target">
 418           <attribution license="cc4" from="Microsoft" modified="false" />A permission object to combine with the current permission object. It must be of the same type as the current permission object. </param>
 419       </Docs>
 420       <AssemblyInfo>
 421         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 422         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 423       </AssemblyInfo>
 424     </Member>
 425   </Members>
 426 </Type>