Skip to content

Automatic port of *PipeServerStreamAcl docs #4880

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Sep 22, 2020
Merged

Automatic port of *PipeServerStreamAcl docs #4880

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3eb856c
Automatic port of *PipeServerStreamAcl docs
carlossanlop Sep 21, 2020
61a1524
Apply suggestions from code review
carlossanlop Sep 21, 2020
0f6790b
Apply suggestions from code review
carlossanlop Sep 21, 2020
4872a22
Apply suggestions from code review
carlossanlop Sep 21, 2020
74813af
Update xml/System.IO.Pipes/AnonymousPipeServerStreamAcl.xml
carlossanlop Sep 21, 2020
f8205be
Update xml/System.IO.Pipes/AnonymousPipeServerStreamAcl.xml
carlossanlop Sep 22, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 23 additions & 7 deletions xml/System.IO.Pipes/AnonymousPipeServerStreamAcl.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,29 @@
<Parameter Name="pipeSecurity" Type="System.IO.Pipes.PipeSecurity" />
</Parameters>
<Docs>
<param name="direction">To be added.</param>
<param name="inheritability">To be added.</param>
<param name="bufferSize">To be added.</param>
<param name="pipeSecurity">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<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>
<param name="inheritability">One of the enumeration values that determines whether the underlying handle can be inherited by child processes.</param>
<param name="bufferSize">The size of the buffer. This value must be greater than or equal to 0.</param>
<param name="pipeSecurity">An object that determines the access control and audit security for the pipe.</param>
<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>
<returns>A new anonymous pipe server stream instance.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

Setting `pipeSecurity` to `null` is equivalent to calling the <xref:System.IO.Pipes.AnonymousPipeServerStream.#ctor(System.IO.Pipes.PipeDirection,System.IO.HandleInheritability,System.Int32)> constructor directly.

]]></format>
</remarks>
<exception cref="T:System.NotSupportedException">
<paramref name="direction" /> is <see cref="F:System.IO.Pipes.PipeDirection.InOut" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="inheritability" /> is not set to a valid <see cref="T:System.IO.HandleInheritability" /> enum value.

-or-

<paramref name="bufferSize" /> is less than 0.</exception>
</Docs>
</Member>
</Members>
Expand Down
58 changes: 45 additions & 13 deletions xml/System.IO.Pipes/NamedPipeServerStreamAcl.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,19 +45,51 @@
<Parameter Name="additionalAccessRights" Type="System.IO.Pipes.PipeAccessRights" />
</Parameters>
<Docs>
<param name="pipeName">To be added.</param>
<param name="direction">To be added.</param>
<param name="maxNumberOfServerInstances">To be added.</param>
<param name="transmissionMode">To be added.</param>
<param name="options">To be added.</param>
<param name="inBufferSize">To be added.</param>
<param name="outBufferSize">To be added.</param>
<param name="pipeSecurity">To be added.</param>
<param name="inheritability">To be added.</param>
<param name="additionalAccessRights">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="pipeName">The name of the pipe.</param>
<param name="direction">One of the enumeration values that determines the direction of the pipe.</param>
<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>
<param name="transmissionMode">One of the enumeration values that determines the transmission mode of the pipe.</param>
<param name="options">One of the enumeration values that determines how to open or create the pipe.</param>
<param name="inBufferSize">The input buffer size.</param>
<param name="outBufferSize">The output buffer size.</param>
<param name="pipeSecurity">An object that determines the access control and audit security for the pipe.</param>
<param name="inheritability">One of the enumeration values that determines whether the underlying handle can be inherited by child processes.</param>
<param name="additionalAccessRights">One of the enumeration values that specifies the access rights of the pipe.</param>
<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>
<returns>A new named pipe server stream instance.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

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.

]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="pipeName" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="pipeName" /> is empty.</exception>
<exception cref="T:System.IO.IOException">
<paramref name="options" /> is <see cref="F:System.IO.Pipes.PipeOptions.None" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="options" /> contains an invalid flag.

-or-

<paramref name="inBufferSize" /> or <paramref name="outBufferSize" /> is less than zero.

-or-

<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" />.

-or-

<paramref name="inheritability" /> contains an invalid enum value.

-or-

<paramref name="pipeName" /> is 'anonymous', which is reserved.</exception>
</Docs>
</Member>
</Members>
Expand Down