Skip to content

Commit 65efde3

Browse files
wtgodbemairaw
authored andcommitted
Document PlatformNotSupportedExceptions in System.Console (#2433)
* Document PlatformNotSupportedExceptions in System.Console * Update Console.xml
1 parent 529f842 commit 65efde3

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

xml/System/Console.xml

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -381,6 +381,7 @@
381381

382382
<paramref name="duration" /> is less than or equal to zero.</exception>
383383
<exception cref="T:System.Security.HostProtectionException">This method was executed on a server, such as SQL Server, that does not permit access to the console.</exception>
384+
<exception cref="T:System.PlatformNotSupportedException">The current operating system is not Windows.</exception>
384385
</Docs>
385386
</Member>
386387
<Member MemberName="BufferHeight">
@@ -452,6 +453,7 @@
452453
The value in a set operation is less than <see cref="P:System.Console.WindowTop" /> + <see cref="P:System.Console.WindowHeight" />.</exception>
453454
<exception cref="T:System.Security.SecurityException">The user does not have permission to perform this action.</exception>
454455
<exception cref="T:System.IO.IOException">An I/O error occurred.</exception>
456+
<exception cref="T:System.PlatformNotSupportedException">The set operation is invoked on an operating system other than Windows.</exception>
455457
<permission cref="T:System.Security.Permissions.UIPermission">for modifying safe top-level windows and subwindows. Associated enumeration: <see cref="F:System.Security.Permissions.UIPermissionWindow.SafeTopLevelWindows" /></permission>
456458
</Docs>
457459
</Member>
@@ -522,6 +524,7 @@
522524
The value in a set operation is less than <see cref="P:System.Console.WindowLeft" /> + <see cref="P:System.Console.WindowWidth" />.</exception>
523525
<exception cref="T:System.Security.SecurityException">The user does not have permission to perform this action.</exception>
524526
<exception cref="T:System.IO.IOException">An I/O error occurred.</exception>
527+
<exception cref="T:System.PlatformNotSupportedException">The set operation is invoked on an operating system other than Windows.</exception>
525528
<permission cref="T:System.Security.Permissions.UIPermission">for modifying safe top-level windows and subwindows. Associated enumeration: <see cref="F:System.Security.Permissions.UIPermissionWindow.SafeTopLevelWindows" /></permission>
526529
</Docs>
527530
</Member>
@@ -635,6 +638,7 @@
635638
<value>
636639
<see langword="true" /> if CAPS LOCK is turned on; <see langword="false" /> if CAPS LOCK is turned off.</value>
637640
<remarks>To be added.</remarks>
641+
<exception cref="T:System.PlatformNotSupportedException">The get operation is invoked on an operating system other than Windows.</exception>
638642
</Docs>
639643
</Member>
640644
<Member MemberName="Clear">
@@ -823,6 +827,7 @@
823827
<exception cref="T:System.ArgumentOutOfRangeException">The value specified in a set operation is less than 1 or greater than 100.</exception>
824828
<exception cref="T:System.Security.SecurityException">The user does not have permission to perform this action.</exception>
825829
<exception cref="T:System.IO.IOException">An I/O error occurred.</exception>
830+
<exception cref="T:System.PlatformNotSupportedException">The set operation is invoked on an operating system other than Windows.</exception>
826831
<permission cref="T:System.Security.Permissions.UIPermission">for modifying safe top-level windows and subwindows. Associated enumeration: <see cref="F:System.Security.Permissions.UIPermissionWindow.SafeTopLevelWindows" /></permission>
827832
</Docs>
828833
</Member>
@@ -941,6 +946,7 @@
941946
</remarks>
942947
<exception cref="T:System.Security.SecurityException">The user does not have permission to perform this action.</exception>
943948
<exception cref="T:System.IO.IOException">An I/O error occurred.</exception>
949+
<exception cref="T:System.PlatformNotSupportedException">The get operation is invoked on an operating system other than Windows.</exception>
944950
<permission cref="T:System.Security.Permissions.UIPermission">for modifying safe top-level windows and subwindows. Associated enumeration: <see cref="F:System.Security.Permissions.UIPermissionWindow.SafeTopLevelWindows" /></permission>
945951
</Docs>
946952
</Member>
@@ -1553,6 +1559,7 @@
15531559
<paramref name="sourceLeft" /> + <paramref name="sourceWidth" /> is greater than or equal to <see cref="P:System.Console.BufferWidth" />.</exception>
15541560
<exception cref="T:System.Security.SecurityException">The user does not have permission to perform this action.</exception>
15551561
<exception cref="T:System.IO.IOException">An I/O error occurred.</exception>
1562+
<exception cref="T:System.PlatformNotSupportedException">The current operating system is not Windows.</exception>
15561563
<permission cref="T:System.Security.Permissions.UIPermission">for modifying safe top-level windows and subwindows. Associated enumeration: <see cref="F:System.Security.Permissions.UIPermissionWindow.SafeTopLevelWindows" /></permission>
15571564
</Docs>
15581565
</Member>
@@ -1643,6 +1650,7 @@
16431650
<exception cref="T:System.ArgumentException">One or both of the color parameters is not a member of the <see cref="T:System.ConsoleColor" /> enumeration.</exception>
16441651
<exception cref="T:System.Security.SecurityException">The user does not have permission to perform this action.</exception>
16451652
<exception cref="T:System.IO.IOException">An I/O error occurred.</exception>
1653+
<exception cref="T:System.PlatformNotSupportedException">The current operating system is not Windows.</exception>
16461654
<permission cref="T:System.Security.Permissions.UIPermission">for modifying safe top-level windows and subwindows. Associated enumeration: <see cref="F:System.Security.Permissions.UIPermissionWindow.SafeTopLevelWindows" /></permission>
16471655
</Docs>
16481656
</Member>
@@ -1684,6 +1692,7 @@
16841692
<value>
16851693
<see langword="true" /> if NUM LOCK is turned on; <see langword="false" /> if NUM LOCK is turned off.</value>
16861694
<remarks>To be added.</remarks>
1695+
<exception cref="T:System.PlatformNotSupportedException">The get operation is invoked on an operating system other than Windows.</exception>
16871696
</Docs>
16881697
</Member>
16891698
<MemberGroup MemberName="OpenStandardError">
@@ -2623,6 +2632,7 @@
26232632
<paramref name="height" /> is less than <see cref="P:System.Console.WindowTop" /> + <see cref="P:System.Console.WindowHeight" />.</exception>
26242633
<exception cref="T:System.Security.SecurityException">The user does not have permission to perform this action.</exception>
26252634
<exception cref="T:System.IO.IOException">An I/O error occurred.</exception>
2635+
<exception cref="T:System.PlatformNotSupportedException">The current operating system is not Windows.</exception>
26262636
<permission cref="T:System.Security.Permissions.UIPermission">for modifying safe top-level windows and subwindows. Associated enumeration: <see cref="F:System.Security.Permissions.UIPermissionWindow.SafeTopLevelWindows" /></permission>
26272637
</Docs>
26282638
</Member>
@@ -2978,6 +2988,7 @@
29782988
<paramref name="top" /> + <see cref="P:System.Console.WindowHeight" /> is greater than <see cref="P:System.Console.BufferHeight" />.</exception>
29792989
<exception cref="T:System.Security.SecurityException">The user does not have permission to perform this action.</exception>
29802990
<exception cref="T:System.IO.IOException">An I/O error occurred.</exception>
2991+
<exception cref="T:System.PlatformNotSupportedException">The current operating system is not Windows.</exception>
29812992
<permission cref="T:System.Security.Permissions.UIPermission">for modifying safe top-level windows and subwindows. Associated enumeration: <see cref="F:System.Security.Permissions.UIPermissionWindow.SafeTopLevelWindows" /></permission>
29822993
</Docs>
29832994
</Member>
@@ -3048,6 +3059,7 @@
30483059
<paramref name="width" /> or <paramref name="height" /> is greater than the largest possible window width or height for the current screen resolution and console font.</exception>
30493060
<exception cref="T:System.Security.SecurityException">The user does not have permission to perform this action.</exception>
30503061
<exception cref="T:System.IO.IOException">An I/O error occurred.</exception>
3062+
<exception cref="T:System.PlatformNotSupportedException">The current operating system is not Windows.</exception>
30513063
<permission cref="T:System.Security.Permissions.UIPermission">for modifying safe top-level windows and subwindows. Associated enumeration: <see cref="F:System.Security.Permissions.UIPermissionWindow.SafeTopLevelWindows" /></permission>
30523064
</Docs>
30533065
</Member>
@@ -3106,6 +3118,7 @@
31063118
<exception cref="T:System.ArgumentOutOfRangeException">In a set operation, the specified title is longer than 24500 characters.</exception>
31073119
<exception cref="T:System.ArgumentNullException">In a set operation, the specified title is <see langword="null" />.</exception>
31083120
<exception cref="T:System.IO.IOException">An I/O error occurred.</exception>
3121+
<exception cref="T:System.PlatformNotSupportedException">The get operation is invoked on an operating system other than Windows.</exception>
31093122
<permission cref="T:System.Security.Permissions.UIPermission">for modifying safe top-level windows and subwindows. Associated enumeration: <see cref="F:System.Security.Permissions.UIPermissionWindow.SafeTopLevelWindows" /></permission>
31103123
</Docs>
31113124
</Member>
@@ -3244,6 +3257,7 @@
32443257

32453258
The value of the <see cref="P:System.Console.WindowWidth" /> property or the value of the <see cref="P:System.Console.WindowHeight" /> property is greater than the largest possible window width or height for the current screen resolution and console font.</exception>
32463259
<exception cref="T:System.IO.IOException">Error reading or writing information.</exception>
3260+
<exception cref="T:System.PlatformNotSupportedException">The set operation is invoked on an operating system other than Windows.</exception>
32473261
</Docs>
32483262
</Member>
32493263
<Member MemberName="WindowLeft">
@@ -3314,6 +3328,7 @@
33143328

33153329
As a result of the assignment, <see cref="P:System.Console.WindowLeft" /> plus <see cref="P:System.Console.WindowWidth" /> would exceed <see cref="P:System.Console.BufferWidth" />.</exception>
33163330
<exception cref="T:System.IO.IOException">Error reading or writing information.</exception>
3331+
<exception cref="T:System.PlatformNotSupportedException">The set operation is invoked on an operating system other than Windows.</exception>
33173332
</Docs>
33183333
</Member>
33193334
<Member MemberName="WindowTop">
@@ -3380,6 +3395,7 @@
33803395

33813396
As a result of the assignment, <see cref="P:System.Console.WindowTop" /> plus <see cref="P:System.Console.WindowHeight" /> would exceed <see cref="P:System.Console.BufferHeight" />.</exception>
33823397
<exception cref="T:System.IO.IOException">Error reading or writing information.</exception>
3398+
<exception cref="T:System.PlatformNotSupportedException">The set operation is invoked on an operating system other than Windows.</exception>
33833399
</Docs>
33843400
</Member>
33853401
<Member MemberName="WindowWidth">
@@ -3450,6 +3466,7 @@
34503466

34513467
The value of the <see cref="P:System.Console.WindowWidth" /> property or the value of the <see cref="P:System.Console.WindowHeight" /> property is greater than the largest possible window width or height for the current screen resolution and console font.</exception>
34523468
<exception cref="T:System.IO.IOException">Error reading or writing information.</exception>
3469+
<exception cref="T:System.PlatformNotSupportedException">The set operation is invoked on an operating system other than Windows.</exception>
34533470
</Docs>
34543471
</Member>
34553472
<MemberGroup MemberName="Write">
@@ -6013,4 +6030,4 @@
60136030
</Docs>
60146031
</Member>
60156032
</Members>
6016-
</Type>
6033+
</Type>

0 commit comments

Comments
 (0)