dotnet / dotnet/dotnet-api-docs

Add examples for *PipeServerStream creation with PipeSecurity (ACLs)

Open
#3,371 0 comments 1 reaction 0 assignees View on GitHub
area-System.IO doc-enhancement example-request Pri3
Dominant language
C#
Stars
949
Forks
1.7k
Avg merge
3d 27m
Merged PRs (30d)
49

Description

It might be good to add examples that explain how to specify the [PipeSecurity](https://docs.microsoft.com/en-us/dotnet/api/system.io.pipes.pipesecurity?view=netcore-3.0)
(ACL) in a [NamedPipeServerStream](https://docs.microsoft.com/en-us/dotnet/api/system.io.pipes.namedpipeserverstream?view=netcore-3.0) and in an [AnonymourPipeServerStream](https://docs.microsoft.com/en-us/dotnet/api/system.io.pipes.anonymouspipeserverstream?view=netcore-3.0). We have usage examples on how to created *PipeServerStream objects, but nothing related to ACLs.

I found a simple example here that could inspire ours: https://weblogs.asp.net/gunnarpeipman/writing-simple-named-pipes-server-in-c

Just one important thing to keep in mind: that example sets the ACL _after_ the creation of the NamedPipeServerStream.

I am currently working on [this issue,](https://github.com/dotnet/corefx/issues/41657) which will add a new extension method that will set the PipeSecurity at the moment when the NamedPipeServerStream is created ([PR here](https://github.com/dotnet/corefx/pull/41838)). When the time comes, I will make sure the documentation for this new API will have a usage example so the user can set ACL at the moment of the pipe creation.

CC @mairaw @JeremyKuhne

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.