Skip to content

Add undocumented 1.x APIs for System.Diagnostics.Process #4183

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.

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
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
bf664b6
Add undocumented APIs for S.Diagnostics.Process
eiriktsarpalis Apr 30, 2020
5f5dedb
Update xml/System.Diagnostics/Process.xml
eiriktsarpalis Apr 30, 2020
60397e2
Update xml/System.Diagnostics/Process.xml
eiriktsarpalis Apr 30, 2020
e38b237
Update xml/System.Diagnostics/ProcessModuleCollection.xml
eiriktsarpalis Apr 30, 2020
c1f7e68
Update xml/System.Diagnostics/ProcessModuleCollection.xml
eiriktsarpalis Apr 30, 2020
4c8d7b6
Update xml/System.Diagnostics/ProcessModuleCollection.xml
eiriktsarpalis Apr 30, 2020
ed455b4
Update xml/System.Diagnostics/ProcessModuleCollection.xml
eiriktsarpalis Apr 30, 2020
4357bd4
Update xml/System.Diagnostics/ProcessModuleCollection.xml
eiriktsarpalis Apr 30, 2020
49e5cbe
Update xml/System.Diagnostics/ProcessModuleCollection.xml
eiriktsarpalis Apr 30, 2020
f1a6343
Update xml/System.Diagnostics/ProcessModuleCollection.xml
eiriktsarpalis Apr 30, 2020
7578a69
Update xml/System.Diagnostics/ProcessThreadCollection.xml
eiriktsarpalis Apr 30, 2020
1f42a5e
Update xml/System.Diagnostics/ProcessThreadCollection.xml
eiriktsarpalis Apr 30, 2020
747d63b
Update xml/System.Diagnostics/ProcessThreadCollection.xml
eiriktsarpalis Apr 30, 2020
d9ab721
Update xml/System.Diagnostics/ProcessThreadCollection.xml
eiriktsarpalis Apr 30, 2020
1382dfc
Update xml/System.Diagnostics/ProcessThreadCollection.xml
eiriktsarpalis Apr 30, 2020
612d335
Update xml/System.Diagnostics/ProcessThreadCollection.xml
eiriktsarpalis Apr 30, 2020
aa98587
Update xml/System.Diagnostics/ProcessThreadCollection.xml
eiriktsarpalis Apr 30, 2020
e5397af
Update xml/System.Diagnostics/ProcessThreadCollection.xml
eiriktsarpalis Apr 30, 2020
9b90b54
Update xml/System.Diagnostics/ProcessThreadCollection.xml
eiriktsarpalis Apr 30, 2020
6acae57
Update xml/System.Diagnostics/ProcessThreadCollection.xml
eiriktsarpalis Apr 30, 2020
02cd18a
Update xml/System.Diagnostics/ProcessModuleCollection.xml
eiriktsarpalis Apr 30, 2020
32f2b6b
Update xml/System.Diagnostics/ProcessModuleCollection.xml
eiriktsarpalis Apr 30, 2020
25f7f2a
Update xml/System.Diagnostics/ProcessModuleCollection.xml
eiriktsarpalis Apr 30, 2020
6612886
add more docs
eiriktsarpalis Apr 30, 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
25 changes: 16 additions & 9 deletions xml/System.Diagnostics/Process.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="Process" FullName="System.Diagnostics.Process">
<Type Name="Process" FullName="System.Diagnostics.Process">
<TypeSignature Language="C#" Value="public class Process : System.ComponentModel.Component, IDisposable" FrameworkAlternate="net-5.0" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Process extends System.ComponentModel.Component implements class System.IDisposable" FrameworkAlternate="net-5.0" />
<TypeSignature Language="DocId" Value="T:System.Diagnostics.Process" />
Expand Down Expand Up @@ -39,8 +39,7 @@
<BaseTypeName>System.ComponentModel.Component</BaseTypeName>
<BaseTypeName FrameworkAlternate="netcore-1.0;netcore-1.1">System.Object</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="netframework-1.1;netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netstandard-2.0;xamarinandroid-7.1;xamarinios-10.8;xamarinmac-3.0;netframework-4.8;netstandard-2.1">
<AttributeName>System.ComponentModel.DefaultEvent("Exited")</AttributeName>
Expand Down Expand Up @@ -774,7 +773,7 @@ process.BeginOutputReadLine();
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -2094,7 +2093,7 @@ There are problems accessing the performance counter API's used to get process i
</Member>
<MemberGroup MemberName="Kill">
<Docs>
<summary>To be added.</summary>
<summary>Forces termination of the underlying process.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

Expand Down Expand Up @@ -6083,10 +6082,18 @@ The file specified in the <paramref name="fileName" /> could not be found.
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="0" FrameworkAlternate="net-5.0" />
</Parameters>
<Docs>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="cancellationToken">An optional token to cancel the asynchronous operation.</param>
<summary>Instructs the process component to wait for the associated process to exit, or for the <paramref name="cancellationToken" /> to be cancelled.</summary>
<returns>A task that will complete when the process has exited, cancellation has been requested, or an error occurs.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

Calling this method will set <xref:System.Diagnostics.Process.EnableRaisingEvents> to `true`.

]]></format>
</remarks>
</Docs>
</Member>
<MemberGroup MemberName="WaitForInputIdle">
Expand Down
48 changes: 32 additions & 16 deletions xml/System.Diagnostics/ProcessModuleCollection.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="ProcessModuleCollection" FullName="System.Diagnostics.ProcessModuleCollection">
<Type Name="ProcessModuleCollection" FullName="System.Diagnostics.ProcessModuleCollection">
<TypeSignature Language="C#" Value="public class ProcessModuleCollection : System.Collections.ReadOnlyCollectionBase" FrameworkAlternate="net-5.0;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1;netframework-1.1;netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netstandard-2.0;netstandard-2.1;xamarinandroid-7.1;xamarinios-10.8;xamarinmac-3.0" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ProcessModuleCollection extends System.Collections.ReadOnlyCollectionBase" FrameworkAlternate="net-5.0;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1;netframework-1.1;netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netstandard-2.0;netstandard-2.1;xamarinandroid-7.1;xamarinios-10.8;xamarinmac-3.0" />
<TypeSignature Language="DocId" Value="T:System.Diagnostics.ProcessModuleCollection" />
Expand Down Expand Up @@ -34,8 +34,7 @@
<BaseTypeName>System.Collections.ReadOnlyCollectionBase</BaseTypeName>
<BaseTypeName FrameworkAlternate="netcore-1.0;netcore-1.1">System.Object</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Interfaces />
<Docs>
<summary>Provides a strongly typed collection of <see cref="T:System.Diagnostics.ProcessModule" /> objects.</summary>
<remarks>
Expand Down Expand Up @@ -650,8 +649,8 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the number of elements contained in the collection.</summary>
<value>The number of elements contained in the collection.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1088,8 +1087,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Returns an enumerator that iterates through a collection.</summary>
<returns>An enumerator object that can be used to iterate through the collection.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1862,9 +1861,9 @@
<Parameter Name="index" Type="System.Int32" Index="1" FrameworkAlternate="netcore-1.0;netcore-1.1" />
</Parameters>
<Docs>
<param name="array">To be added.</param>
<param name="index">To be added.</param>
<summary>To be added.</summary>
<param name="array">The one-dimensional array that is the destination of the elements copied from collection. The array must have zero-based indexing.</param>
<param name="index">The zero-based index in <paramref name="array" /> at which copying begins.</param>
<summary>Copies the elements of the collection to an array, starting at a particular array index.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1893,9 +1892,18 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets a value indicating whether access to the collection is synchronized (thread safe).</summary>
<value>
<see langword="true" /> if access to the collection is synchronized (thread safe); otherwise, <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This member is an explicit interface member implementation. It can be used only when the <xref:System.Diagnostics.ProcessModuleCollection> instance is cast to an <xref:System.Collections.ICollection> interface.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="System.Collections.ICollection.SyncRoot">
Expand Down Expand Up @@ -1923,9 +1931,17 @@
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets an object that can be used to synchronize access to the collection.</summary>
<value>An object that can be used to synchronize access to the collection.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This member is an explicit interface member implementation. It can be used only when the <xref:System.Diagnostics.ProcessModuleCollection> instance is cast to an <xref:System.Collections.ICollection> interface.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ToArray">
Expand Down
48 changes: 32 additions & 16 deletions xml/System.Diagnostics/ProcessThreadCollection.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="ProcessThreadCollection" FullName="System.Diagnostics.ProcessThreadCollection">
<Type Name="ProcessThreadCollection" FullName="System.Diagnostics.ProcessThreadCollection">
<TypeSignature Language="C#" Value="public class ProcessThreadCollection : System.Collections.ReadOnlyCollectionBase" FrameworkAlternate="net-5.0;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1;netframework-1.1;netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netstandard-2.0;netstandard-2.1;xamarinandroid-7.1;xamarinios-10.8;xamarinmac-3.0" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ProcessThreadCollection extends System.Collections.ReadOnlyCollectionBase" FrameworkAlternate="net-5.0;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1;netframework-1.1;netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netstandard-2.0;netstandard-2.1;xamarinandroid-7.1;xamarinios-10.8;xamarinmac-3.0" />
<TypeSignature Language="DocId" Value="T:System.Diagnostics.ProcessThreadCollection" />
Expand Down Expand Up @@ -34,8 +34,7 @@
<BaseTypeName>System.Collections.ReadOnlyCollectionBase</BaseTypeName>
<BaseTypeName FrameworkAlternate="netcore-1.0;netcore-1.1">System.Object</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Interfaces />
<Docs>
<summary>Provides a strongly typed collection of <see cref="T:System.Diagnostics.ProcessThread" /> objects.</summary>
<remarks>To be added.</remarks>
Expand Down Expand Up @@ -647,8 +646,8 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the number of elements contained in the collection.</summary>
<value>The number of elements contained in the collection.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1085,8 +1084,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Returns an enumerator that iterates through a collection.</summary>
<returns>An enumerator object that can be used to iterate through the collection.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1868,9 +1867,9 @@
<Parameter Name="index" Type="System.Int32" Index="1" FrameworkAlternate="netcore-1.0;netcore-1.1" />
</Parameters>
<Docs>
<param name="array">To be added.</param>
<param name="index">To be added.</param>
<summary>To be added.</summary>
<param name="array">The one-dimensional array that is the destination of the elements copied from collection. The array must have zero-based indexing.</param>
<param name="index">The zero-based index in <paramref name="array" /> at which copying begins.</param>
<summary>Copies the elements of the collection to an array, starting at a particular array index.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1899,9 +1898,18 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets a value indicating whether access to the collection is synchronized (thread safe).</summary>
<value>
<see langword="true" /> if access to the collection is synchronized (thread safe); otherwise, <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This member is an explicit interface member implementation. It can be used only when the <xref:System.Diagnostics.ProcessThreadCollection> instance is cast to an <xref:System.Collections.ICollection> interface.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="System.Collections.ICollection.SyncRoot">
Expand Down Expand Up @@ -1929,9 +1937,17 @@
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets an object that can be used to synchronize access to the collection.</summary>
<value>An object that can be used to synchronize access to the collection.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This member is an explicit interface member implementation. It can be used only when the <xref:System.Diagnostics.ProcessThreadCollection> instance is cast to an <xref:System.Collections.ICollection> interface.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ToArray">
Expand Down
42 changes: 37 additions & 5 deletions xml/System.Diagnostics/TraceListenerCollection.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="TraceListenerCollection" FullName="System.Diagnostics.TraceListenerCollection">
<Type Name="TraceListenerCollection" FullName="System.Diagnostics.TraceListenerCollection">
<TypeSignature Language="C#" Value="public class TraceListenerCollection : System.Collections.IList" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit TraceListenerCollection extends System.Object implements class System.Collections.ICollection, class System.Collections.IEnumerable, class System.Collections.IList" />
<TypeSignature Language="DocId" Value="T:System.Diagnostics.TraceListenerCollection" />
Expand Down Expand Up @@ -974,7 +974,15 @@
<Docs>
<summary>Gets a value indicating whether access to the <see cref="T:System.Diagnostics.TraceListenerCollection" /> is synchronized (thread safe).</summary>
<value>Always <see langword="true" />.</value>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This member is an explicit interface member implementation. It can be used only when the <xref:System.Diagnostics.TraceListenerCollection> instance is cast to an <xref:System.Collections.ICollection> interface.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="System.Collections.ICollection.SyncRoot">
Expand Down Expand Up @@ -1013,7 +1021,15 @@
<Docs>
<summary>Gets an object that can be used to synchronize access to the <see cref="T:System.Diagnostics.TraceListenerCollection" />.</summary>
<value>The current <see cref="T:System.Diagnostics.TraceListenerCollection" /> object.</value>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This member is an explicit interface member implementation. It can be used only when the <xref:System.Diagnostics.TraceListenerCollection> instance is cast to an <xref:System.Collections.ICollection> interface.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="System.Collections.IList.Add">
Expand Down Expand Up @@ -1266,7 +1282,15 @@
<Docs>
<summary>Gets a value indicating whether the <see cref="T:System.Diagnostics.TraceListenerCollection" /> has a fixed size.</summary>
<value>Always <see langword="false" />.</value>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This member is an explicit interface member implementation. It can be used only when the <xref:System.Diagnostics.TraceListenerCollection> instance is cast to an <xref:System.Collections.IList> interface.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="System.Collections.IList.IsReadOnly">
Expand Down Expand Up @@ -1305,7 +1329,15 @@
<Docs>
<summary>Gets a value indicating whether the <see cref="T:System.Diagnostics.TraceListenerCollection" /> is read-only.</summary>
<value>Always <see langword="false" />.</value>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This member is an explicit interface member implementation. It can be used only when the <xref:System.Diagnostics.TraceListenerCollection> instance is cast to an <xref:System.Collections.IList> interface.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="System.Collections.IList.Item">
Expand Down