8000 Automatic port of *PipeServerStreamAcl docs (#4880) · dotnet/dotnet-api-docs@512d018 · GitHub
[go: up one dir, main page]
Skip to content

Commit 512d018

Browse files
carlossanlopPrashanth Govindarajanjozkee
authored
Automatic port of *PipeServerStreamAcl docs (#4880)
* Automatic port of *PipeServerStreamAcl docs * Apply suggestions from code review Co-authored-by: Prashanth Govindarajan <prgovi@microsoft.com> Co-authored-by: David Cantú <dacantu@microsoft.com> * Apply suggestions from code review Co-authored-by: David Cantú <dacantu@microsoft.com> * Apply suggestions from code review * Update xml/System.IO.Pipes/AnonymousPipeServerStreamAcl.xml * Update xml/System.IO.Pipes/AnonymousPipeServerStreamAcl.xml Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> Co-authored-by: Prashanth Govindarajan <prgovi@microsoft.com> Co-authored-by: David Cantú <dacantu@microsoft.com>
1 parent 195d898 commit 512d018

File tree

2 files changed

+68
-20
lines changed

2 files changed

+68
-20
lines changed

‎xml/System.IO.Pipes/AnonymousPipeServerStreamAcl.xml

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,29 @@
4040
<Parameter Name="pipeSecurity" Type="System.IO.Pipes.PipeSecurity" />
4141
</Parameters>
4242
<Docs>
43-
<param name="direction">To be added.</param>
44-
<param name="inheritability">To be added.</param>
45-
<param name="bufferSize">To be added.</param>
46-
<param name="pipeSecurity">To be added.</param>
47-
<summary>To be added.</summary>
48-
<returns>To be added.</returns>
49-
<remarks>To be added.</remarks>
43+
<param name="direction">One of the enumeration values that determines the direction of the pipe. Anonymous pipes are unidirectional, so direction cannot be set to <see cref="F:System.IO.Pipes.PipeDirection.InOut" />.</param>
44+
<param name="inheritability">One of the enumeration values that determines whether the underlying handle can be inherited by child processes.</param>
45+
<param name="bufferSize">The size of the buffer. This value must be greater than or equal to 0.</param>
46+
<param name="pipeSecurity">An object that determines the access control and audit security for the pipe.</param>
47+
<summary>Creates a new instance of the <see cref="T:System.IO.Pipes.AnonymousPipeServerStream" /> class with the specified pipe direction, inheritability mode, buffer size, and pipe security.</summary>
48+
<returns>A new anonymous pipe server stream instance.</returns>
49+
<remarks>
50+
<format type="text/markdown"><![CDATA[
51+
52+
## Remarks
53+
54+
Setting `pipeSecurity` to `null` is equivalent to calling the <xref:System.IO.Pipes.AnonymousPipeServerStream.%23ctor(System.IO.Pipes.PipeDirection,System.IO.HandleInheritability,System.Int32)> constructor directly.
55+
56+
]]></format>
57+
</remarks>
58+
<exception cref="T:System.NotSupportedException">
59+
<paramref name="direction" /> is <see cref="F:System.IO.Pipes.PipeDirection.InOut" />.</exception>
60+
<exception cref="T:System.ArgumentOutOfRangeException">
61+
<paramref name="inheritability" /> is not set to a valid <see cref="T:System.IO.HandleInheritability" /> enum value.
62+
63+
-or-
64+
65+
<paramref name="bufferSize" /> is less than 0.</exception>
5066
</Docs>
5167
</Member>
5268
</Members>

‎xml/System.IO.Pipes/NamedPipeServerStreamAcl.xml

Lines changed: 45 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -45,19 +45,51 @@
4545
<Parameter Name="additionalAccessRights" Type="System.IO.Pipes.PipeAccessRights" />
4646
</Parameters>
4747
<Docs>
48-
<param name="pipeName">To be added.</param>
49-
<param name="direction">To be added.</param>
50-
<param name="maxNumberOfServerInstances">To be added.</param>
51-
<param name="transmissionMode">To be added.</param>
52-
<param name="options">To be added.</param>
53-
<param name="inBufferSize">To be added.</param>
54-
<param name="outBufferSize">To be added.</param>
55-
<param name="pipeSecurity">To be added.</param>
56-
<param name="inheritability">To be added.</param>
57-
<param name="additionalAccessRights">To be added.</param>
58-
<summary>To be added.</summary>
59-
<returns>To be added.</returns>
60-
<remarks>To be added.</remarks>
48+
<param name="pipeName">The name of the pipe.</param>
49+
<param name="direction">One of the enumeration values that determines the direction of the pipe.</param>
50+
<param name="maxNumberOfServerInstances">The maximum number of server instances that share the same name. You can pass <see cref="F:System.IO.Pipes.NamedPipeServerStream.MaxAllowedServerInstances" /> for this value.</param>
51+
<param name="transmissionMode">One of the enumeration values that determines the transmission mode of the pipe.</param>
52+
<param name="options">One of the enumeration values that determines how to open or create the pipe.</param>
53+
<param name="inBufferSize">The input buffer size.</param>
54+
<param name="outBufferSize">The output buffer size.</param>
55+
<param name="pipeSecurity">An object that determines the access control and audit security for the pipe.</param>
56+
<param name="inheritability">One of the enumeration values that determines whether the underlying handle can be inherited by child processes.</param>
57+
<param name="additionalAccessRights">One of the enumeration values that specifies the access rights of the pipe.</param>
58+
<summary>Creates a new instance of the <see cref="T:System.IO.Pipes.NamedPipeServerStream" /> class with the specified pipe name, pipe direction, maximum number of server instances, transmission mode, pipe options, recommended in and out buffer sizes, pipe security, inheritability mode, and pipe access rights.</summary>
59+
<returns>A new named pipe server stream instance.</returns>
60+
<remarks>
61+
<format type="text/markdown"><![CDATA[
62+
63+
## Remarks
64+
65+
If `options` contains <xref:System.IO.Pipes.PipeOptions.CurrentUserOnly>, the passed `pipeSecurity` is ignored and the returned <xref:System.IO.Pipes.NamedPipeServerStream> object is created using a custom <xref:System.IO.Pipes.PipeSecurity> instance assigned to the current Windows user as its only owner with full control of the pipe.
66+
67+
]]></format>
68+
</remarks>
69+
<exception cref="T:System.ArgumentNullException">
70+
<paramref name="pipeName" /> is <see langword="null" />.</exception>
71+
<exception cref="T:System.ArgumentException">
72+
<paramref name="pipeName" /> is empty.</exception>
73+
<exception cref="T:System.IO.IOException">
74+
<paramref name="options" /> is <see cref="F:System.IO.Pipes.PipeOptions.None" />.</exception>
75+
<exception cref="T:System.ArgumentOutOfRangeException">
76+
<paramref name="options" /> contains an invalid flag.
77+
78+
-or-
79+
80+
<paramref name="inBufferSize" /> or <paramref name="outBufferSize" /> is less than zero.
81+
82+
-or-
83+
84+
<paramref name="maxNumberOfServerInstances" /> is not a valid number: it should be greater than or equal to 1 and less than or equal to 254, or should be set to the value of <see cref="F:System.IO.Pipes.NamedPipeServerStream.MaxAllowedServerInstances" />.
85+
86+
-or-
87+
88+
<paramref name="inheritability" /> contains an invalid enum value.
89+
90+
-or-
91+
92+
<paramref name="pipeName" /> is 'anonymous', which is reserved.</exception>
6193
</Docs>
6294
</Member>
6395
</Members>

0 commit comments

Comments
 (0)
0