Skip to content

Commit f7a58a3

Browse files
authored
Document System.IO.PipesAclExtensions (#3933)
1 parent 4d5ad21 commit f7a58a3

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

xml/System.IO.Pipes/PipesAclExtensions.xml

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
</Base>
1818
<Interfaces />
1919
<Docs>
20-
<summary>To be added.</summary>
20+
<summary>Provides Windows-specific static extension methods for manipulating Access Control List (ACL) security attributes for pipe streams.</summary>
2121
<remarks>To be added.</remarks>
2222
</Docs>
2323
<Members>
@@ -48,9 +48,9 @@
4848
<Parameter Name="stream" Type="System.IO.Pipes.PipeStream" RefType="this" />
4949
</Parameters>
5050
<Docs>
51-
<param name="stream">To be added.</param>
52-
<summary>To be added.</summary>
53-
<returns>To be added.</returns>
51+
<param name="stream">The existing pipe stream from which to obtain the security information.</param>
52+
<summary>Returns the security information of a pipe stream.</summary>
53+
<returns>The security descriptors of all the access control sections of the pipe stream.</returns>
5454
<remarks>To be added.</remarks>
5555
</Docs>
5656
</Member>
@@ -81,10 +81,16 @@
8181
<Parameter Name="pipeSecurity" Type="System.IO.Pipes.PipeSecurity" />
8282
</Parameters>
8383
<Docs>
84-
<param name="stream">To be added.</param>
85-
<param name="pipeSecurity">To be added.</param>
86-
<summary>To be added.</summary>
84+
<param name="stream">An existing pipe stream.</param>
85+
<param name="pipeSecurity">The security information to apply to the pipe stream.</param>
86+
<summary>Changes the security attributes of an existing pipe stream.</summary>
8787
<remarks>To be added.</remarks>
88+
<exception cref="ArgumentNullException">
89+
<paramref name="pipeSecurity" /> is <see langword="null" />.
90+
</exception>
91+
<exception cref="IOException">
92+
<paramref name="stream" /> is a disconnected <see cref="T:System.IO.Pipes.NamedPipeClientStream" /> instance.
93+
</exception>
8894
</Docs>
8995
</Member>
9096
</Members>

0 commit comments

Comments
 (0)