PipeSecurity.xml 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <Type Name="PipeSecurity" FullName="System.IO.Pipes.PipeSecurity">
  3. <TypeSignature Language="C#" Value="public class PipeSecurity : System.Security.AccessControl.NativeObjectSecurity" />
  4. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PipeSecurity extends System.Security.AccessControl.NativeObjectSecurity" />
  5. <AssemblyInfo>
  6. <AssemblyName>System.Core</AssemblyName>
  7. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  8. </AssemblyInfo>
  9. <Base>
  10. <BaseTypeName>System.Security.AccessControl.NativeObjectSecurity</BaseTypeName>
  11. </Base>
  12. <Interfaces />
  13. <Docs>
  14. <remarks>
  15. <attribution license="cc4" from="Microsoft" modified="false" />
  16. <para>The <see cref="T:System.IO.Pipes.PipeSecurity" /> class specifies the access rights for a pipe and how access attempts are audited. This class represents access and audit rights as a set of rules. Each access rule is represented by a <see cref="T:System.IO.Pipes.PipeAccessRule" /> object, while each audit rule is represented by a <see cref="T:System.IO.Pipes.PipeAuditRule" /> object.</para>
  17. <para>The <see cref="T:System.IO.Pipes.PipeSecurity" /> class is an abstraction of the underlying Microsoft Windows file security system. In this system, each pipe has a discretionary access control list (DACL), which controls access to the pipe, and a system access control list (SACL), which specifies the access control attempts that are audited. The <see cref="T:System.IO.Pipes.PipeAccessRule" /> and <see cref="T:System.IO.Pipes.PipeAuditRule" /> classes are abstractions of the access control entries (ACEs) that comprise DACLs and SACLs. </para>
  18. <para>The <see cref="T:System.IO.Pipes.PipeSecurity" /> class hides many of the details of DACLs and SACLs; you do not have to worry about ACE ordering or null DACLS.</para>
  19. <para>Use the <see cref="T:System.IO.Pipes.PipeSecurity" /> class to retrieve, add, or change the access rules that represent the DACL and SACL of a pipe.</para>
  20. <para>To persist new or changed access or audit rules to a pipe, use the <see cref="M:System.IO.Pipes.PipeStream.SetAccessControl(System.IO.Pipes.PipeSecurity)" /> method. To retrieve access or audit rules from an existing file, use the <see cref="M:System.IO.Pipes.PipeStream.GetAccessControl" /> method.</para>
  21. </remarks>
  22. <summary>
  23. <attribution license="cc4" from="Microsoft" modified="false" />
  24. <para>Represents the access control and audit security for a pipe.</para>
  25. </summary>
  26. </Docs>
  27. <Members>
  28. <Member MemberName=".ctor">
  29. <MemberSignature Language="C#" Value="public PipeSecurity ();" />
  30. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
  31. <MemberType>Constructor</MemberType>
  32. <AssemblyInfo>
  33. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  34. </AssemblyInfo>
  35. <Parameters />
  36. <Docs>
  37. <remarks>
  38. <attribution license="cc4" from="Microsoft" modified="false" />
  39. <para>This constructor creates an empty <see cref="T:System.IO.Pipes.PipeSecurity" /> object that is not based on an existing pipe. You can then populate the object with access control information and apply it to a pipe.</para>
  40. <para>You can add access or audit rules to the <see cref="T:System.IO.Pipes.PipeSecurity" /> object using the <see cref="M:System.IO.Pipes.PipeSecurity.AddAccessRule(System.IO.Pipes.PipeAccessRule)" /> method. You can remove access or audit rules using the <see cref="M:System.IO.Pipes.PipeSecurity.RemoveAccessRule(System.IO.Pipes.PipeAccessRule)" /> method.</para>
  41. <para>To persist new or changed access or audit rules to a pipe, use the <see cref="M:System.IO.Pipes.PipeStream.SetAccessControl(System.IO.Pipes.PipeSecurity)" /> method. To retrieve access or audit rules from an existing file, use the <see cref="M:System.IO.Pipes.PipeStream.GetAccessControl" /> method.</para>
  42. </remarks>
  43. <summary>
  44. <attribution license="cc4" from="Microsoft" modified="false" />
  45. <para>Initializes a new instance of the <see cref="T:System.IO.Pipes.PipeSecurity" /> class.</para>
  46. </summary>
  47. </Docs>
  48. </Member>
  49. <Member MemberName="AccessRightType">
  50. <MemberSignature Language="C#" Value="public override Type AccessRightType { get; }" />
  51. <MemberSignature Language="ILAsm" Value=".property instance class System.Type AccessRightType" />
  52. <MemberType>Property</MemberType>
  53. <AssemblyInfo>
  54. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  55. </AssemblyInfo>
  56. <ReturnValue>
  57. <ReturnType>System.Type</ReturnType>
  58. </ReturnValue>
  59. <Docs>
  60. <value>To be added.</value>
  61. <remarks>
  62. <attribution license="cc4" from="Microsoft" modified="false" />
  63. <para>Classes that derive from the <see cref="T:System.Security.AccessControl.ObjectSecurity" /> class override the <see cref="P:System.Security.AccessControl.ObjectSecurity.AccessRightType" /> property and return the type they use to represent access rights. When you work with arrays or collections that contain multiple types of security objects, use this property to determine the correct enumeration type to use with each security object.</para>
  64. </remarks>
  65. <summary>
  66. <attribution license="cc4" from="Microsoft" modified="false" />
  67. <para>Gets the <see cref="T:System.Type" /> of the securable object that is associated with the current <see cref="T:System.IO.Pipes.PipeSecurity" /> object.</para>
  68. </summary>
  69. </Docs>
  70. </Member>
  71. <Member MemberName="AccessRuleFactory">
  72. <MemberSignature Language="C#" Value="public override System.Security.AccessControl.AccessRule AccessRuleFactory (System.Security.Principal.IdentityReference identityReference, int accessMask, bool isInherited, System.Security.AccessControl.InheritanceFlags inheritanceFlags, System.Security.AccessControl.PropagationFlags propagationFlags, System.Security.AccessControl.AccessControlType type);" />
  73. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Security.AccessControl.AccessRule AccessRuleFactory(class System.Security.Principal.IdentityReference identityReference, int32 accessMask, bool isInherited, valuetype System.Security.AccessControl.InheritanceFlags inheritanceFlags, valuetype System.Security.AccessControl.PropagationFlags propagationFlags, valuetype System.Security.AccessControl.AccessControlType type) cil managed" />
  74. <MemberType>Method</MemberType>
  75. <AssemblyInfo>
  76. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  77. </AssemblyInfo>
  78. <ReturnValue>
  79. <ReturnType>System.Security.AccessControl.AccessRule</ReturnType>
  80. </ReturnValue>
  81. <Parameters>
  82. <Parameter Name="identityReference" Type="System.Security.Principal.IdentityReference" />
  83. <Parameter Name="accessMask" Type="System.Int32" />
  84. <Parameter Name="isInherited" Type="System.Boolean" />
  85. <Parameter Name="inheritanceFlags" Type="System.Security.AccessControl.InheritanceFlags" />
  86. <Parameter Name="propagationFlags" Type="System.Security.AccessControl.PropagationFlags" />
  87. <Parameter Name="type" Type="System.Security.AccessControl.AccessControlType" />
  88. </Parameters>
  89. <Docs>
  90. <remarks>
  91. <attribution license="cc4" from="Microsoft" modified="false" />
  92. <para>The recommended way to create access control rules is to use the constructors of the <see cref="T:System.IO.Pipes.PipeAccessRule" /> class.</para>
  93. </remarks>
  94. <summary>
  95. <attribution license="cc4" from="Microsoft" modified="false" />
  96. <para>Initializes a new instance of the <see cref="T:System.Security.AccessControl.AccessRule" /> class with the specified values.</para>
  97. </summary>
  98. <returns>
  99. <attribution license="cc4" from="Microsoft" modified="false" />
  100. <para>The <see cref="T:System.Security.AccessControl.AccessRule" /> object that this method creates.</para>
  101. </returns>
  102. <param name="identityReference">
  103. <attribution license="cc4" from="Microsoft" modified="false" />The identity that the access rule applies to. It must be an object that can be cast as a <see cref="T:System.Security.Principal.SecurityIdentifier" /> object.</param>
  104. <param name="accessMask">
  105. <attribution license="cc4" from="Microsoft" modified="false" />The access mask of this rule. The access mask is a 32-bit collection of anonymous bits, the meaning of which is defined by the individual integrators</param>
  106. <param name="isInherited">
  107. <attribution license="cc4" from="Microsoft" modified="false" />true if this rule is inherited from a parent container; otherwise false.</param>
  108. <param name="inheritanceFlags">
  109. <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Security.AccessControl.InheritanceFlags" /> values that specifies the inheritance properties of the access rule.</param>
  110. <param name="propagationFlags">
  111. <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Security.AccessControl.PropagationFlags" /> values that specifies whether inherited access rules are automatically propagated. The propagation flags are ignored if <paramref name="inheritanceFlags" /> is set to <see cref="F:System.Security.AccessControl.InheritanceFlags.None" />.</param>
  112. <param name="type">
  113. <attribution license="cc4" from="Microsoft" modified="false" />Specifies the valid access control type.</param>
  114. </Docs>
  115. </Member>
  116. <Member MemberName="AccessRuleType">
  117. <MemberSignature Language="C#" Value="public override Type AccessRuleType { get; }" />
  118. <MemberSignature Language="ILAsm" Value=".property instance class System.Type AccessRuleType" />
  119. <MemberType>Property</MemberType>
  120. <AssemblyInfo>
  121. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  122. </AssemblyInfo>
  123. <ReturnValue>
  124. <ReturnType>System.Type</ReturnType>
  125. </ReturnValue>
  126. <Docs>
  127. <value>To be added.</value>
  128. <remarks>
  129. <attribution license="cc4" from="Microsoft" modified="false" />
  130. <para>Classes that derive from the <see cref="T:System.Security.AccessControl.ObjectSecurity" /> class override the <see cref="P:System.Security.AccessControl.ObjectSecurity.AccessRuleType" /> property and return the type they use to represent access rights. When you work with arrays or collections that contain multiple types of security objects, use this property to determine the correct enumeration type to use with each security object.</para>
  131. </remarks>
  132. <summary>
  133. <attribution license="cc4" from="Microsoft" modified="false" />
  134. <para>Gets the <see cref="T:System.Type" /> of the object that is associated with the access rules of the current <see cref="T:System.IO.Pipes.PipeSecurity" /> object.</para>
  135. </summary>
  136. </Docs>
  137. </Member>
  138. <Member MemberName="AddAccessRule">
  139. <MemberSignature Language="C#" Value="public void AddAccessRule (System.IO.Pipes.PipeAccessRule rule);" />
  140. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddAccessRule(class System.IO.Pipes.PipeAccessRule rule) cil managed" />
  141. <MemberType>Method</MemberType>
  142. <AssemblyInfo>
  143. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  144. </AssemblyInfo>
  145. <ReturnValue>
  146. <ReturnType>System.Void</ReturnType>
  147. </ReturnValue>
  148. <Parameters>
  149. <Parameter Name="rule" Type="System.IO.Pipes.PipeAccessRule" />
  150. </Parameters>
  151. <Docs>
  152. <remarks>
  153. <attribution license="cc4" from="Microsoft" modified="false" />
  154. <para>The <see cref="M:System.IO.Pipes.PipeSecurity.AddAccessRule(System.IO.Pipes.PipeAccessRule)" /> method adds a new rule to the list of rules that a <see cref="T:System.IO.Pipes.PipeSecurity" /> object contains.If an access control list (ACL) already exists for the specified rule, the <see cref="M:System.IO.Pipes.PipeSecurity.AddAccessRule(System.IO.Pipes.PipeAccessRule)" /> method will still add the rule, with one exception: a <see cref="T:System.IO.Pipes.PipeAccessRule" /> object that is created using the <see cref="F:System.Security.AccessControl.AccessControlType.Deny" /> value supersedes an object that is created using the <see cref="F:System.Security.AccessControl.AccessControlType.Allow" /> value.</para>
  155. </remarks>
  156. <summary>
  157. <attribution license="cc4" from="Microsoft" modified="false" />
  158. <para>Adds an access rule to the Discretionary Access Control List (DACL) that is associated with the current <see cref="T:System.IO.Pipes.PipeSecurity" /> object.</para>
  159. </summary>
  160. <param name="rule">
  161. <attribution license="cc4" from="Microsoft" modified="false" />The access rule to add.</param>
  162. </Docs>
  163. </Member>
  164. <Member MemberName="AddAuditRule">
  165. <MemberSignature Language="C#" Value="public void AddAuditRule (System.IO.Pipes.PipeAuditRule rule);" />
  166. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddAuditRule(class System.IO.Pipes.PipeAuditRule rule) cil managed" />
  167. <MemberType>Method</MemberType>
  168. <AssemblyInfo>
  169. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  170. </AssemblyInfo>
  171. <ReturnValue>
  172. <ReturnType>System.Void</ReturnType>
  173. </ReturnValue>
  174. <Parameters>
  175. <Parameter Name="rule" Type="System.IO.Pipes.PipeAuditRule" />
  176. </Parameters>
  177. <Docs>
  178. <remarks>
  179. <attribution license="cc4" from="Microsoft" modified="false" />
  180. <para>The <see cref="M:System.IO.Pipes.PipeSecurity.AddAuditRule(System.IO.Pipes.PipeAuditRule)" /> method adds a new audit rule to the list of rules that a <see cref="T:System.IO.Pipes.PipeSecurity" /> object contains.</para>
  181. <para>If an audit rule already exists for the specified rule, the <see cref="M:System.IO.Pipes.PipeSecurity.AddAuditRule(System.IO.Pipes.PipeAuditRule)" /> method will still add the rule.</para>
  182. </remarks>
  183. <summary>
  184. <attribution license="cc4" from="Microsoft" modified="false" />
  185. <para>Adds an audit rule to the System Access Control List (SACL)that is associated with the current <see cref="T:System.IO.Pipes.PipeSecurity" /> object.</para>
  186. </summary>
  187. <param name="rule">
  188. <attribution license="cc4" from="Microsoft" modified="false" />The audit rule to add.</param>
  189. </Docs>
  190. </Member>
  191. <Member MemberName="AuditRuleFactory">
  192. <MemberSignature Language="C#" Value="public override sealed System.Security.AccessControl.AuditRule AuditRuleFactory (System.Security.Principal.IdentityReference identityReference, int accessMask, bool isInherited, System.Security.AccessControl.InheritanceFlags inheritanceFlags, System.Security.AccessControl.PropagationFlags propagationFlags, System.Security.AccessControl.AuditFlags flags);" />
  193. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Security.AccessControl.AuditRule AuditRuleFactory(class System.Security.Principal.IdentityReference identityReference, int32 accessMask, bool isInherited, valuetype System.Security.AccessControl.InheritanceFlags inheritanceFlags, valuetype System.Security.AccessControl.PropagationFlags propagationFlags, valuetype System.Security.AccessControl.AuditFlags flags) cil managed" />
  194. <MemberType>Method</MemberType>
  195. <AssemblyInfo>
  196. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  197. </AssemblyInfo>
  198. <ReturnValue>
  199. <ReturnType>System.Security.AccessControl.AuditRule</ReturnType>
  200. </ReturnValue>
  201. <Parameters>
  202. <Parameter Name="identityReference" Type="System.Security.Principal.IdentityReference" />
  203. <Parameter Name="accessMask" Type="System.Int32" />
  204. <Parameter Name="isInherited" Type="System.Boolean" />
  205. <Parameter Name="inheritanceFlags" Type="System.Security.AccessControl.InheritanceFlags" />
  206. <Parameter Name="propagationFlags" Type="System.Security.AccessControl.PropagationFlags" />
  207. <Parameter Name="flags" Type="System.Security.AccessControl.AuditFlags" />
  208. </Parameters>
  209. <Docs>
  210. <remarks>
  211. <attribution license="cc4" from="Microsoft" modified="false" />
  212. <para>The recommended way to create audit rules is to use the constructors of the <see cref="T:System.IO.Pipes.PipeAuditRule" /> class.</para>
  213. </remarks>
  214. <summary>
  215. <attribution license="cc4" from="Microsoft" modified="false" />
  216. <para>Initializes a new instance of the <see cref="T:System.Security.AccessControl.AuditRule" /> class with the specified values.</para>
  217. </summary>
  218. <returns>
  219. <attribution license="cc4" from="Microsoft" modified="false" />
  220. <para>The <see cref="T:System.Security.AccessControl.AuditRule" /> object that this method creates.</para>
  221. </returns>
  222. <param name="identityReference">
  223. <attribution license="cc4" from="Microsoft" modified="false" />The identity that the access rule applies to. It must be an object that can be cast as a <see cref="T:System.Security.Principal.SecurityIdentifier" /> object.</param>
  224. <param name="accessMask">
  225. <attribution license="cc4" from="Microsoft" modified="false" />The access mask of this rule. The access mask is a 32-bit collection of anonymous bits, the meaning of which is defined by the individual integrators</param>
  226. <param name="isInherited">
  227. <attribution license="cc4" from="Microsoft" modified="false" />true if this rule is inherited from a parent container; otherwise, false..</param>
  228. <param name="inheritanceFlags">
  229. <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Security.AccessControl.InheritanceFlags" /> values that specifies the inheritance properties of the access rule.</param>
  230. <param name="propagationFlags">
  231. <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Security.AccessControl.PropagationFlags" /> values that specifies whether inherited access rules are automatically propagated. The propagation flags are ignored if <paramref name="inheritanceFlags" /> is set to <see cref="F:System.Security.AccessControl.InheritanceFlags.None" />.</param>
  232. <param name="flags">
  233. <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Security.AccessControl.AuditFlags" /> values that specifies the valid access control type.</param>
  234. </Docs>
  235. </Member>
  236. <Member MemberName="AuditRuleType">
  237. <MemberSignature Language="C#" Value="public override Type AuditRuleType { get; }" />
  238. <MemberSignature Language="ILAsm" Value=".property instance class System.Type AuditRuleType" />
  239. <MemberType>Property</MemberType>
  240. <AssemblyInfo>
  241. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  242. </AssemblyInfo>
  243. <ReturnValue>
  244. <ReturnType>System.Type</ReturnType>
  245. </ReturnValue>
  246. <Docs>
  247. <value>To be added.</value>
  248. <remarks>
  249. <attribution license="cc4" from="Microsoft" modified="false" />
  250. <para>Classes that derive from the <see cref="T:System.Security.AccessControl.ObjectSecurity" /> class override the <see cref="P:System.Security.AccessControl.ObjectSecurity.AuditRuleType" /> property and return the type they use to represent access rights. When you work with arrays or collections that contain multiple types of security objects, use this property to determine the correct enumeration type to use with each security object.</para>
  251. </remarks>
  252. <summary>
  253. <attribution license="cc4" from="Microsoft" modified="false" />
  254. <para>Gets the <see cref="T:System.Type" /> object associated with the audit rules of the current <see cref="T:System.IO.Pipes.PipeSecurity" /> object.</para>
  255. </summary>
  256. </Docs>
  257. </Member>
  258. <Member MemberName="Persist">
  259. <MemberSignature Language="C#" Value="protected void Persist (System.Runtime.InteropServices.SafeHandle handle);" />
  260. <MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig instance void Persist(class System.Runtime.InteropServices.SafeHandle handle) cil managed" />
  261. <MemberType>Method</MemberType>
  262. <AssemblyInfo>
  263. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  264. </AssemblyInfo>
  265. <ReturnValue>
  266. <ReturnType>System.Void</ReturnType>
  267. </ReturnValue>
  268. <Parameters>
  269. <Parameter Name="handle" Type="System.Runtime.InteropServices.SafeHandle" />
  270. </Parameters>
  271. <Docs>
  272. <remarks>To be added.</remarks>
  273. <summary>
  274. <attribution license="cc4" from="Microsoft" modified="false" />
  275. <para>Saves the specified sections of the security descriptor that is associated with the current <see cref="T:System.IO.Pipes.PipeSecurity" /> object to permanent storage.</para>
  276. </summary>
  277. <param name="handle">
  278. <attribution license="cc4" from="Microsoft" modified="false" />The handle of the securable object that the current <see cref="T:System.IO.Pipes.PipeSecurity" /> object is associated with.</param>
  279. </Docs>
  280. </Member>
  281. <Member MemberName="Persist">
  282. <MemberSignature Language="C#" Value="protected void Persist (string name);" />
  283. <MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig instance void Persist(string name) cil managed" />
  284. <MemberType>Method</MemberType>
  285. <AssemblyInfo>
  286. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  287. </AssemblyInfo>
  288. <ReturnValue>
  289. <ReturnType>System.Void</ReturnType>
  290. </ReturnValue>
  291. <Parameters>
  292. <Parameter Name="name" Type="System.String" />
  293. </Parameters>
  294. <Docs>
  295. <remarks>To be added.</remarks>
  296. <summary>
  297. <attribution license="cc4" from="Microsoft" modified="false" />
  298. <para>Saves the specified sections of the security descriptor that is associated with the current <see cref="T:System.IO.Pipes.PipeSecurity" /> object to permanent storage.</para>
  299. </summary>
  300. <param name="name">
  301. <attribution license="cc4" from="Microsoft" modified="false" />The name of the securable object that the current <see cref="T:System.IO.Pipes.PipeSecurity" /> object is associated with.</param>
  302. </Docs>
  303. </Member>
  304. <Member MemberName="RemoveAccessRule">
  305. <MemberSignature Language="C#" Value="public bool RemoveAccessRule (System.IO.Pipes.PipeAccessRule rule);" />
  306. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool RemoveAccessRule(class System.IO.Pipes.PipeAccessRule rule) cil managed" />
  307. <MemberType>Method</MemberType>
  308. <AssemblyInfo>
  309. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  310. </AssemblyInfo>
  311. <ReturnValue>
  312. <ReturnType>System.Boolean</ReturnType>
  313. </ReturnValue>
  314. <Parameters>
  315. <Parameter Name="rule" Type="System.IO.Pipes.PipeAccessRule" />
  316. </Parameters>
  317. <Docs>
  318. <remarks>
  319. <attribution license="cc4" from="Microsoft" modified="false" />
  320. <para>The <see cref="M:System.IO.Pipes.PipeSecurity.RemoveAccessRule(System.IO.Pipes.PipeAccessRule)" /> method removes either all matching <see cref="F:System.Security.AccessControl.AccessControlType.Deny" /> access rules or all matching <see cref="F:System.Security.AccessControl.AccessControlType.Allow" /> access rules from the current <see cref="T:System.IO.Pipes.PipeSecurity" /> object. For example, you can use this method to remove all <see cref="F:System.Security.AccessControl.AccessControlType.Deny" /> access rules for a user by passing a <see cref="T:System.IO.Pipes.PipeAccessRule" /> object created using the <see cref="F:System.Security.AccessControl.AccessControlType.Deny" /> value, the <see cref="F:System.IO.Pipes.PipeAccessRights.Read" /> value, and a user account. The <see cref="M:System.IO.Pipes.PipeSecurity.RemoveAccessRule(System.IO.Pipes.PipeAccessRule)" /> method removes any deny rules that specify the <see cref="F:System.IO.Pipes.PipeAccessRights.Read" /> value or the <see cref="F:System.IO.Pipes.PipeAccessRights.Write" /> value.</para>
  321. </remarks>
  322. <summary>
  323. <attribution license="cc4" from="Microsoft" modified="false" />
  324. <para>Removes an access rule from the Discretionary Access Control List (DACL) that is associated with the current <see cref="T:System.IO.Pipes.PipeSecurity" /> object.</para>
  325. </summary>
  326. <returns>
  327. <attribution license="cc4" from="Microsoft" modified="false" />
  328. <para>true if the operation is successful; otherwise, false.</para>
  329. </returns>
  330. <param name="rule">
  331. <attribution license="cc4" from="Microsoft" modified="false" />The access rule to remove.</param>
  332. </Docs>
  333. </Member>
  334. <Member MemberName="RemoveAccessRuleSpecific">
  335. <MemberSignature Language="C#" Value="public void RemoveAccessRuleSpecific (System.IO.Pipes.PipeAccessRule rule);" />
  336. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemoveAccessRuleSpecific(class System.IO.Pipes.PipeAccessRule rule) cil managed" />
  337. <MemberType>Method</MemberType>
  338. <AssemblyInfo>
  339. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  340. </AssemblyInfo>
  341. <ReturnValue>
  342. <ReturnType>System.Void</ReturnType>
  343. </ReturnValue>
  344. <Parameters>
  345. <Parameter Name="rule" Type="System.IO.Pipes.PipeAccessRule" />
  346. </Parameters>
  347. <Docs>
  348. <remarks>
  349. <attribution license="cc4" from="Microsoft" modified="false" />
  350. <para>The <see cref="M:System.IO.Pipes.PipeSecurity.RemoveAccessRule(System.IO.Pipes.PipeAccessRule)" /> method removes either all matching <see cref="F:System.Security.AccessControl.AccessControlType.Deny" /> access rules or all matching <see cref="F:System.Security.AccessControl.AccessControlType.Allow" /> access rules from the current <see cref="T:System.IO.Pipes.PipeSecurity" /> object. For example, you can use this method to remove all <see cref="F:System.Security.AccessControl.AccessControlType.Deny" /> access rules for a user by passing a <see cref="T:System.IO.Pipes.PipeAccessRule" /> object created using the <see cref="F:System.Security.AccessControl.AccessControlType.Deny" /> value, the <see cref="F:System.IO.Pipes.PipeAccessRights.Read" /> value, and a user account. The <see cref="M:System.IO.Pipes.PipeSecurity.RemoveAccessRule(System.IO.Pipes.PipeAccessRule)" /> method removes any deny rules that specify the <see cref="F:System.IO.Pipes.PipeAccessRights.Read" /> value or the <see cref="F:System.IO.Pipes.PipeAccessRights.Write" /> value.</para>
  351. </remarks>
  352. <summary>
  353. <attribution license="cc4" from="Microsoft" modified="false" />
  354. <para>Removes the specified access rule from the Discretionary Access Control List (DACL) that is associated with the current <see cref="T:System.IO.Pipes.PipeSecurity" /> object.</para>
  355. </summary>
  356. <param name="rule">
  357. <attribution license="cc4" from="Microsoft" modified="false" />The access rule to remove.</param>
  358. </Docs>
  359. </Member>
  360. <Member MemberName="RemoveAuditRule">
  361. <MemberSignature Language="C#" Value="public bool RemoveAuditRule (System.IO.Pipes.PipeAuditRule rule);" />
  362. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool RemoveAuditRule(class System.IO.Pipes.PipeAuditRule rule) cil managed" />
  363. <MemberType>Method</MemberType>
  364. <AssemblyInfo>
  365. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  366. </AssemblyInfo>
  367. <ReturnValue>
  368. <ReturnType>System.Boolean</ReturnType>
  369. </ReturnValue>
  370. <Parameters>
  371. <Parameter Name="rule" Type="System.IO.Pipes.PipeAuditRule" />
  372. </Parameters>
  373. <Docs>
  374. <remarks>
  375. <attribution license="cc4" from="Microsoft" modified="false" />
  376. <para>The <see cref="M:System.IO.Pipes.PipeSecurity.RemoveAuditRule(System.IO.Pipes.PipeAuditRule)" /> method removes either all matching <see cref="F:System.Security.AccessControl.AccessControlType.Deny" /> audit rules or all matching <see cref="F:System.Security.AccessControl.AccessControlType.Allow" /> audit rules from the current <see cref="T:System.IO.Pipes.PipeSecurity" /> object. For example, you can use this method to remove all <see cref="F:System.Security.AccessControl.AccessControlType.Deny" /> audit rules for a user by passing a <see cref="T:System.Security.AccessControl.FileSystemAuditRule" /> object created using the <see cref="F:System.Security.AccessControl.AccessControlType.Deny" /> value, the <see cref="F:System.Security.AccessControl.AuditFlags.Failure" /> value, and a user account. When you do this, the <see cref="M:System.IO.Pipes.PipeSecurity.RemoveAuditRule(System.IO.Pipes.PipeAuditRule)" /> method removes any deny rules that specify the <see cref="F:System.Security.AccessControl.AuditFlags.Failure" /> value or the <see cref="F:System.Security.AccessControl.AuditFlags.Success" /> value.</para>
  377. </remarks>
  378. <summary>
  379. <attribution license="cc4" from="Microsoft" modified="false" />
  380. <para>Removes an audit rule from the System Access Control List (SACL) that is associated with the current <see cref="T:System.IO.Pipes.PipeSecurity" /> object.</para>
  381. </summary>
  382. <returns>
  383. <attribution license="cc4" from="Microsoft" modified="false" />
  384. <para>true if the audit rule was removed; otherwise, false</para>
  385. </returns>
  386. <param name="rule">
  387. <attribution license="cc4" from="Microsoft" modified="false" />The audit rule to remove.</param>
  388. </Docs>
  389. </Member>
  390. <Member MemberName="RemoveAuditRuleAll">
  391. <MemberSignature Language="C#" Value="public void RemoveAuditRuleAll (System.IO.Pipes.PipeAuditRule rule);" />
  392. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemoveAuditRuleAll(class System.IO.Pipes.PipeAuditRule rule) cil managed" />
  393. <MemberType>Method</MemberType>
  394. <AssemblyInfo>
  395. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  396. </AssemblyInfo>
  397. <ReturnValue>
  398. <ReturnType>System.Void</ReturnType>
  399. </ReturnValue>
  400. <Parameters>
  401. <Parameter Name="rule" Type="System.IO.Pipes.PipeAuditRule" />
  402. </Parameters>
  403. <Docs>
  404. <remarks>
  405. <attribution license="cc4" from="Microsoft" modified="false" />
  406. <para>The <see cref="M:System.IO.Pipes.PipeSecurity.RemoveAuditRuleAll(System.IO.Pipes.PipeAuditRule)" /> method removes all audit rules for the specified user. It ignores all values in the <see cref="T:System.IO.Pipes.PipeAuditRule" /> object except the user account.</para>
  407. </remarks>
  408. <summary>
  409. <attribution license="cc4" from="Microsoft" modified="false" />
  410. <para>Removes all audit rules that have the same security identifier as the specified audit rule from the System Access Control List (SACL) that is associated with the current <see cref="T:System.IO.Pipes.PipeSecurity" /> object.</para>
  411. </summary>
  412. <param name="rule">
  413. <attribution license="cc4" from="Microsoft" modified="false" />The audit rule to remove.</param>
  414. </Docs>
  415. </Member>
  416. <Member MemberName="RemoveAuditRuleSpecific">
  417. <MemberSignature Language="C#" Value="public void RemoveAuditRuleSpecific (System.IO.Pipes.PipeAuditRule rule);" />
  418. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemoveAuditRuleSpecific(class System.IO.Pipes.PipeAuditRule rule) cil managed" />
  419. <MemberType>Method</MemberType>
  420. <AssemblyInfo>
  421. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  422. </AssemblyInfo>
  423. <ReturnValue>
  424. <ReturnType>System.Void</ReturnType>
  425. </ReturnValue>
  426. <Parameters>
  427. <Parameter Name="rule" Type="System.IO.Pipes.PipeAuditRule" />
  428. </Parameters>
  429. <Docs>
  430. <remarks>
  431. <attribution license="cc4" from="Microsoft" modified="false" />
  432. <para>The <see cref="M:System.IO.Pipes.PipeSecurity.RemoveAuditRuleSpecific(System.IO.Pipes.PipeAuditRule)" /> method removes the specified matching <see cref="F:System.Security.AccessControl.AccessControlType.Deny" /> audit rule or the specified matching <see cref="F:System.Security.AccessControl.AccessControlType.Allow" /> audit rule from the current <see cref="T:System.IO.Pipes.PipeSecurity" /> object. For example, you can use this method to remove a specified <see cref="F:System.Security.AccessControl.AccessControlType.Deny" /> audit rule for a user by passing a <see cref="T:System.Security.AccessControl.FileSystemAuditRule" /> object created using the <see cref="F:System.Security.AccessControl.AccessControlType.Deny" /> value, the <see cref="F:System.Security.AccessControl.AuditFlags.Failure" /> value, and a user account. When you do this, the <see cref="M:System.IO.Pipes.PipeSecurity.RemoveAuditRuleSpecific(System.IO.Pipes.PipeAuditRule)" /> method removes only a deny rule that specifies the <see cref="F:System.Security.AccessControl.AuditFlags.Failure" /> value. It does not remove any deny rules that specify the <see cref="F:System.Security.AccessControl.AuditFlags.Success" /> value.</para>
  433. </remarks>
  434. <summary>
  435. <attribution license="cc4" from="Microsoft" modified="false" />
  436. <para>Removes the specified audit rule from the System Access Control List (SACL) that is associated with the current <see cref="T:System.IO.Pipes.PipeSecurity" /> object.</para>
  437. </summary>
  438. <param name="rule">
  439. <attribution license="cc4" from="Microsoft" modified="false" />The audit rule to remove.</param>
  440. </Docs>
  441. </Member>
  442. <Member MemberName="ResetAccessRule">
  443. <MemberSignature Language="C#" Value="public void ResetAccessRule (System.IO.Pipes.PipeAccessRule rule);" />
  444. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ResetAccessRule(class System.IO.Pipes.PipeAccessRule rule) cil managed" />
  445. <MemberType>Method</MemberType>
  446. <AssemblyInfo>
  447. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  448. </AssemblyInfo>
  449. <ReturnValue>
  450. <ReturnType>System.Void</ReturnType>
  451. </ReturnValue>
  452. <Parameters>
  453. <Parameter Name="rule" Type="System.IO.Pipes.PipeAccessRule" />
  454. </Parameters>
  455. <Docs>
  456. <remarks>
  457. <attribution license="cc4" from="Microsoft" modified="false" />
  458. <para>The <see cref="M:System.IO.Pipes.PipeSecurity.ResetAccessRule(System.IO.Pipes.PipeAccessRule)" /> method adds the specified access control list (ACL) rule or overwrites any identical ACL rules that match the <paramref name="rule" /> parameter. For example, if the <paramref name="rule" /> parameter specifies a <see cref="F:System.IO.Pipes.PipeAccessRights.Read" /> value and the <see cref="M:System.IO.Pipes.PipeSecurity.ResetAccessRule(System.IO.Pipes.PipeAccessRule)" /> method finds an identical ACL rule that specifies the <see cref="F:System.IO.Pipes.PipeAccessRights.Read" /> value, the identical rule will be overwritten. If the <see cref="M:System.IO.Pipes.PipeSecurity.ResetAccessRule(System.IO.Pipes.PipeAccessRule)" /> method finds an identical ACL rule that specifies the <see cref="F:System.IO.Pipes.PipeAccessRights.Write" /> value, the identical rule will also be overwritten. </para>
  459. </remarks>
  460. <summary>
  461. <attribution license="cc4" from="Microsoft" modified="false" />
  462. <para>Removes all access rules in the Discretionary Access Control List (DACL) that is associated with the current <see cref="T:System.IO.Pipes.PipeSecurity" /> object and then adds the specified access rule.</para>
  463. </summary>
  464. <param name="rule">
  465. <attribution license="cc4" from="Microsoft" modified="false" />The access rule to add.</param>
  466. </Docs>
  467. </Member>
  468. <Member MemberName="SetAccessRule">
  469. <MemberSignature Language="C#" Value="public void SetAccessRule (System.IO.Pipes.PipeAccessRule rule);" />
  470. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetAccessRule(class System.IO.Pipes.PipeAccessRule rule) cil managed" />
  471. <MemberType>Method</MemberType>
  472. <AssemblyInfo>
  473. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  474. </AssemblyInfo>
  475. <ReturnValue>
  476. <ReturnType>System.Void</ReturnType>
  477. </ReturnValue>
  478. <Parameters>
  479. <Parameter Name="rule" Type="System.IO.Pipes.PipeAccessRule" />
  480. </Parameters>
  481. <Docs>
  482. <remarks>
  483. <attribution license="cc4" from="Microsoft" modified="false" />
  484. <para>The <see cref="M:System.IO.Pipes.PipeSecurity.SetAccessRule(System.IO.Pipes.PipeAccessRule)" /> method adds the specified access control list (ACL) rule or overwrites any identical ACL rules that match the <see cref="T:System.IO.Pipes.PipeAccessRights" /> value of the <paramref name="rule" /> parameter. For example, if the <paramref name="rule" /> parameter specifies a <see cref="F:System.IO.Pipes.PipeAccessRights.Read" /> value and the <see cref="M:System.IO.Pipes.PipeSecurity.SetAccessRule(System.IO.Pipes.PipeAccessRule)" /> method finds an identical ACL rule that specifies the <see cref="F:System.IO.Pipes.PipeAccessRights.Read" /> value, the identical rule will be overwritten. If the <see cref="M:System.IO.Pipes.PipeSecurity.SetAccessRule(System.IO.Pipes.PipeAccessRule)" /> method finds an identical ACL rule that specifies the <see cref="F:System.IO.Pipes.PipeAccessRights.Write" /> value, the identical rule will not be overwritten. </para>
  485. </remarks>
  486. <summary>
  487. <attribution license="cc4" from="Microsoft" modified="false" />
  488. <para>Sets an access rule in the Discretionary Access Control List (DACL) that is associated with the current <see cref="T:System.IO.Pipes.PipeSecurity" /> object.</para>
  489. </summary>
  490. <param name="rule">
  491. <attribution license="cc4" from="Microsoft" modified="false" />The rule to set.</param>
  492. </Docs>
  493. </Member>
  494. <Member MemberName="SetAuditRule">
  495. <MemberSignature Language="C#" Value="public void SetAuditRule (System.IO.Pipes.PipeAuditRule rule);" />
  496. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetAuditRule(class System.IO.Pipes.PipeAuditRule rule) cil managed" />
  497. <MemberType>Method</MemberType>
  498. <AssemblyInfo>
  499. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  500. </AssemblyInfo>
  501. <ReturnValue>
  502. <ReturnType>System.Void</ReturnType>
  503. </ReturnValue>
  504. <Parameters>
  505. <Parameter Name="rule" Type="System.IO.Pipes.PipeAuditRule" />
  506. </Parameters>
  507. <Docs>
  508. <remarks>
  509. <attribution license="cc4" from="Microsoft" modified="false" />
  510. <para>The <see cref="M:System.IO.Pipes.PipeSecurity.SetAuditRule(System.IO.Pipes.PipeAuditRule)" /> method adds the specified audit rule or overwrites any identical audit rules that match the <see cref="T:System.IO.Pipes.PipeAccessRights" /> value of the <paramref name="rule" /> parameter. For example, if the <paramref name="rule" /> parameter specifies a <see cref="F:System.IO.Pipes.PipeAccessRights.Read" /> value and the <see cref="M:System.IO.Pipes.PipeSecurity.SetAuditRule(System.IO.Pipes.PipeAuditRule)" /> method finds an identical audit rule that specifies the <see cref="F:System.IO.Pipes.PipeAccessRights.Read" /> value, the identical rule will be overwritten. If the <see cref="M:System.IO.Pipes.PipeSecurity.SetAuditRule(System.IO.Pipes.PipeAuditRule)" /> method finds an identical audit rule that specifies the <see cref="F:System.IO.Pipes.PipeAccessRights.Write" /> value, the identical rule will not be overwritten. </para>
  511. </remarks>
  512. <summary>
  513. <attribution license="cc4" from="Microsoft" modified="false" />
  514. <para>Sets an audit rule in the System Access Control List (SACL) that is associated with the current <see cref="T:System.IO.Pipes.PipeSecurity" /> object.</para>
  515. </summary>
  516. <param name="rule">
  517. <attribution license="cc4" from="Microsoft" modified="false" />The rule to set.</param>
  518. </Docs>
  519. </Member>
  520. </Members>
  521. </Type>