dotnet / dotnet/dotnet-api-docs

Add examples for *PipeServerStream creation with PipeSecurity (ACLs)

Offen
#3,371 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen
area-System.IO doc-enhancement example-request Pri3
Vorherrschende Sprache
C#
Sterne
949
Forks
1.7k
Ø Merge
2 T. 19 Std.
Gemergte PRs (30 T.)
52

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginnen Sie damit, die vorhandenen Verwendungsbeispiele für NamedPipeServerStream und AnonymousPipeServerStream in der API-Referenz zu finden. Prüfen Sie anschließend die verlinkte PipeSecurity-Dokumentation und verwandte API-Arbeiten. Als erledigt gilt die Aufgabe, wenn beide Beispiele für Server-Streams das Konfigurieren von ACLs erläutern, einschließlich des im Issue beschriebenen Falls zur Konfiguration bei der Erstellung.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
42/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.