Skip to content

Commit 1a2aaa2

Browse files
mairawmairaw
authored
Add PNSE info to MemoryMappedFile.CreateNew (#2866)
1 parent 017acc9 commit 1a2aaa2

File tree

1 file changed

+27
-24
lines changed

1 file changed

+27
-24
lines changed

‎xml/System.IO.MemoryMappedFiles/MemoryMappedFile.xml

Lines changed: 27 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
5656
]]></format>
5757
</remarks>
58-
<related type="Article" href="https://msdn.microsoft.com/library/a483d1b5-64aa-45b6-86ef-11b859f7f02e">Memory-Mapped Files</related>
58+
<related type="Article" href="~/docs/standard/io/memory-mapped-files.md">Memory-Mapped Files</related>
5959
</Docs>
6060
<Members>
6161
<MemberGroup MemberName="CreateFromFile">
@@ -125,7 +125,7 @@
125125
<exception cref="T:System.IO.PathTooLongException">
126126
<paramref name="path" /> exceeds the maximum length defined by the operating system. </exception>
127127
<exception cref="T:System.Security.SecurityException">The caller does not have the required permissions for the file.</exception>
128-
<related type="Article" href="https://msdn.microsoft.com/library/a483d1b5-64aa-45b6-86ef-11b859f7f02e">Memory-Mapped Files</related>
128+
<related type="Article" href="~/docs/standard/io/memory-mapped-files.md">Memory-Mapped Files</related>
129129
</Docs>
130130
</Member>
131131
<Member MemberName="CreateFromFile">
@@ -197,7 +197,7 @@
197197
<exception cref="T:System.IO.PathTooLongException">
198198
<paramref name="path" /> exceeds the maximum length defined by the operating system. </exception>
199199
<exception cref="T:System.Security.SecurityException">The caller does not have the required permissions for the file.</exception>
200-
<related type="Article" href="https://msdn.microsoft.com/library/a483d1b5-64aa-45b6-86ef-11b859f7f02e">Memory-Mapped Files</related>
200+
<related type="Article" href="~/docs/standard/io/memory-mapped-files.md">Memory-Mapped Files</related>
201201
</Docs>
202202
</Member>
203203
<Member MemberName="CreateFromFile">
@@ -474,7 +474,7 @@
474474
<paramref name="path" /> exceeds the maximum length defined by the operating system. </exception>
475475
<exception cref="T:System.Security.SecurityException">The caller does not have the required permissions for the file.</exception>
476476
<permission cref="T:System.Security.Permissions.SecurityPermission">for access to unmanaged code. Associated enumeration: <see cref="F:System.Security.Permissions.SecurityPermissionFlag.UnmanagedCode" />.</permission>
477-
<related type="Article" href="https://msdn.microsoft.com/library/a483d1b5-64aa-45b6-86ef-11b859f7f02e">Memory-Mapped Files</related>
477+
<related type="Article" href="~/docs/standard/io/memory-mapped-files.md">Memory-Mapped Files</related>
478478
</Docs>
479479
</Member>
480480
<Member MemberName="CreateFromFile">
@@ -646,7 +646,7 @@
646646
<exception cref="T:System.IO.IOException">
647647
<paramref name="mapName" /> already exists.</exception>
648648
<permission cref="T:System.Security.Permissions.SecurityPermission">for access to unmanaged code. Associated enumeration: <see cref="F:System.Security.Permissions.SecurityPermissionFlag.UnmanagedCode" />.</permission>
649-
<related type="Article" href="https://msdn.microsoft.com/library/a483d1b5-64aa-45b6-86ef-11b859f7f02e">Memory-Mapped Files</related>
649+
<related type="Article" href="~/docs/standard/io/memory-mapped-files.md">Memory-Mapped Files</related>
650650
</Docs>
651651
</Member>
652652
<MemberGroup MemberName="CreateNew">
@@ -766,7 +766,8 @@ Process C says: True
766766
<paramref name="mapName" /> is an empty string.</exception>
767767
<exception cref="T:System.ArgumentOutOfRangeException">
768768
<paramref name="capacity" /> is less than or equal to zero.</exception>
769-
<related type="Article" href="https://msdn.microsoft.com/library/a483d1b5-64aa-45b6-86ef-11b859f7f02e">Memory-Mapped Files</related>
769+
<exception cref="T:System.PlatformNotSupportedException">.NET Core only: Calls to the <c>CreateNew</c> method with a named memory mapped file (that is, a non-null <paramref name="mapName" />) are supported on Windows operating systems only.</exception>
770+
<related type="Article" href="~/docs/standard/io/memory-mapped-files.md">Memory-Mapped Files</related>
770771
</Docs>
771772
</Member>
772773
<Member MemberName="CreateNew">
@@ -832,7 +833,8 @@ Process C says: True
832833
-or-
833834

834835
<paramref name="access" /> is not a valid <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedFileAccess" /> enumeration value.</exception>
835-
<related type="Article" href="https://msdn.microsoft.com/library/a483d1b5-64aa-45b6-86ef-11b859f7f02e">Memory-Mapped Files</related>
836+
<exception cref="T:System.PlatformNotSupportedException">.NET Core only: Calls to the <c>CreateNew</c> method with a named memory mapped file (that is, a non-null <paramref name="mapName" />) are supported on Windows operating systems only.</exception>
837+
<related type="Article" href="~/docs/standard/io/memory-mapped-files.md">Memory-Mapped Files</related>
836838
</Docs>
837839
</Member>
838840
<Member MemberName="CreateNew">
@@ -894,6 +896,7 @@ Process C says: True
894896
-or-
895897

896898
<paramref name="inheritability" /> is not a valid <see cref="T:System.IO.HandleInheritability" /> value.</exception>
899+
<exception cref="T:System.PlatformNotSupportedException">.NET Core only: Calls to the <c>CreateNew</c> method with a named memory mapped file (that is, a non-null <paramref name="mapName" />) are supported on Windows operating systems only.</exception>
897900
</Docs>
898901
</Member>
899902
<Member MemberName="CreateNew">
@@ -966,7 +969,7 @@ Process C says: True
966969

967970
<paramref name="inheritability" /> is not a valid <see cref="T:System.IO.HandleInheritability" /> enumeration value.</exception>
968971
<permission cref="T:System.Security.Permissions.SecurityPermission">for access to unmanaged code. Associated enumeration: <see cref="F:System.Security.Permissions.SecurityPermissionFlag.UnmanagedCode" />.</permission>
969-
<related type="Article" href="https://msdn.microsoft.com/library/a483d1b5-64aa-45b6-86ef-11b859f7f02e">Memory-Mapped Files</related>
972+
<related type="Article" href="~/docs/standard/io/memory-mapped-files.md">Memory-Mapped Files</related>
970973
</Docs>
971974
</Member>
972975
<MemberGroup MemberName="CreateOrOpen">
@@ -1036,7 +1039,7 @@ Process C says: True
10361039
-or-
10371040

10381041
<paramref name="capacity" /> is less than or equal to zero.</exception>
1039-
<related type="Article" href="https://msdn.microsoft.com/library/a483d1b5-64aa-45b6-86ef-11b859f7f02e">Memory-Mapped Files</related>
1042+
<related type="Article" href="~/docs/standard/io/memory-mapped-files.md">Memory-Mapped Files</related>
10401043
</Docs>
10411044
</Member>
10421045
<Member MemberName="CreateOrOpen">
@@ -1109,7 +1112,7 @@ Process C says: True
11091112

11101113
<paramref name="access" /> is not a valid <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedFileAccess" /> enumeration value.</exception>
11111114
<exception cref="T:System.UnauthorizedAccessException">The operating system denied the specified access to the file; for example, access is set to <see cref="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.Write" /> or <see cref="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.ReadWrite" />, but the file or directory is read-only.</exception>
1112-
<related type="Article" href="https://msdn.microsoft.com/library/a483d1b5-64aa-45b6-86ef-11b859f7f02e">Memory-Mapped Files</related>
1115+
<related type="Article" href="~/docs/standard/io/memory-mapped-files.md">Memory-Mapped Files</related>
11131116
</Docs>
11141117
</Member>
11151118
<Member MemberName="CreateOrOpen">
@@ -1257,7 +1260,7 @@ Process C says: True
12571260
<paramref name="inheritability" /> is not a valid <see cref="T:System.IO.HandleInheritability" /> enumeration value.</exception>
12581261
<exception cref="T:System.UnauthorizedAccessException">The operating system denied the specified <paramref name="access" /> to the file; for example, <paramref name="access" /> is set to <see cref="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.Write" /> or <see cref="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.ReadWrite" />, but the file or directory is read-only.</exception>
12591262
<permission cref="T:System.Security.Permissions.SecurityPermission">for access to unmanaged code. Associated enumeration: <see cref="F:System.Security.Permissions.SecurityPermissionFlag.UnmanagedCode" />.</permission>
1260-
<related type="Article" href="https://msdn.microsoft.com/library/a483d1b5-64aa-45b6-86ef-11b859f7f02e">Memory-Mapped Files</related>
1263+
<related type="Article" href="~/docs/standard/io/memory-mapped-files.md">Memory-Mapped Files</related>
12611264
</Docs>
12621265
</Member>
12631266
<MemberGroup MemberName="CreateViewAccessor">
@@ -1310,7 +1313,7 @@ Process C says: True
13101313
]]></format>
13111314
</remarks>
13121315
<exception cref="T:System.UnauthorizedAccessException">Access to the memory-mapped file is unauthorized.</exception>
1313-
<related type="Article" href="https://msdn.microsoft.com/library/a483d1b5-64aa-45b6-86ef-11b859f7f02e">Memory-Mapped Files</related>
1316+
<related type="Article" href="~/docs/standard/io/memory-mapped-files.md">Memory-Mapped Files</related>
13141317
</Docs>
13151318
</Member>
13161319
<Member MemberName="CreateViewAccessor">
@@ -1380,7 +1383,7 @@ Process C says: True
13801383
<paramref name="size" /> is greater than the logical address space.</exception>
13811384
<exception cref="T:System.UnauthorizedAccessException">Access to the memory-mapped file is unauthorized.</exception>
13821385
<exception cref="T:System.IO.IOException">An I/O error occurred.</exception>
1383-
<related type="Article" href="https://msdn.microsoft.com/library/a483d1b5-64aa-45b6-86ef-11b859f7f02e">Memory-Mapped Files</related>
1386+
<related type="Article" href="~/docs/standard/io/memory-mapped-files.md">Memory-Mapped Files</related>
13841387
</Docs>
13851388
</Member>
13861389
<Member MemberName="CreateViewAccessor">
@@ -1446,7 +1449,7 @@ Process C says: True
14461449
<paramref name="access" /> is invalid for the memory-mapped file.</exception>
14471450
<exception cref="T:System.IO.IOException">An I/O error occurred.</exception>
14481451
<permission cref="T:System.Security.Permissions.SecurityPermission">for access to unmanaged code. Associated enumeration: <see cref="F:System.Security.Permissions.SecurityPermissionFlag.UnmanagedCode" />.</permission>
1449-
<related type="Article" href="https://msdn.microsoft.com/library/a483d1b5-64aa-45b6-86ef-11b859f7f02e">Memory-Mapped Files</related>
1452+
<related type="Article" href="~/docs/standard/io/memory-mapped-files.md">Memory-Mapped Files</related>
14501453
</Docs>
14511454
</Member>
14521455
<MemberGroup MemberName="CreateViewStream">
@@ -1507,7 +1510,7 @@ Process C says: True
15071510
]]></format>
15081511
</remarks>
15091512
<exception cref="T:System.UnauthorizedAccessException">Access to the memory-mapped file is unauthorized.</exception>
1510-
<related type="Article" href="https://msdn.microsoft.com/library/a483d1b5-64aa-45b6-86ef-11b859f7f02e">Memory-Mapped Files</related>
1513+
<related type="Article" href="~/docs/standard/io/memory-mapped-files.md">Memory-Mapped Files</related>
15111514
</Docs>
15121515
</Member>
15131516
<Member MemberName="CreateViewStream">
@@ -1570,7 +1573,7 @@ Process C says: True
15701573
<exception cref="T:System.UnauthorizedAccessException">Access to the memory-mapped file is unauthorized.</exception>
15711574
<exception cref="T:System.IO.IOException">
15721575
<paramref name="size" /> is greater than the total virtual memory.</exception>
1573-
<related type="Article" href="https://msdn.microsoft.com/library/a483d1b5-64aa-45b6-86ef-11b859f7f02e">Memory-Mapped Files</related>
1576+
<related type="Article" href="~/docs/standard/io/memory-mapped-files.md">Memory-Mapped Files</related>
15741577
</Docs>
15751578
</Member>
15761579
<Member MemberName="CreateViewStream">
@@ -1645,7 +1648,7 @@ Process C says: True
16451648

16461649
<paramref name="access" /> is invalid for the memory-mapped file.</exception>
16471650
<permission cref="T:System.Security.Permissions.SecurityPermission">for access to unmanaged code. Associated enumeration: <see cref="F:System.Security.Permissions.SecurityPermissionFlag.UnmanagedCode" />.</permission>
1648-
<related type="Article" href="https://msdn.microsoft.com/library/a483d1b5-64aa-45b6-86ef-11b859f7f02e">Memory-Mapped Files</related>
1651+
<related type="Article" href="~/docs/standard/io/memory-mapped-files.md">Memory-Mapped Files</related>
16491652
</Docs>
16501653
</Member>
16511654
<MemberGroup MemberName="Dispose">
@@ -1785,7 +1788,7 @@ Process C says: True
17851788
-or-
17861789

17871790
The memory-mapped file was opened as <see cref="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.Write" /> only.</exception>
1788-
<related type="Article" href="https://msdn.microsoft.com/library/a483d1b5-64aa-45b6-86ef-11b859f7f02e">Memory-Mapped Files</related>
1791+
<related type="Article" href="~/docs/standard/io/memory-mapped-files.md">Memory-Mapped Files</related>
17891792
</Docs>
17901793
</Member>
17911794
<MemberGroup MemberName="OpenExisting">
@@ -1864,7 +1867,7 @@ Process C says: True
18641867
<exception cref="T:System.ArgumentException">
18651868
<paramref name="mapName" /> is an empty string.</exception>
18661869
<exception cref="T:System.IO.FileNotFoundException">The file specified for <paramref name="mapName" /> does not exist.</exception>
1867-
<related type="Article" href="https://msdn.microsoft.com/library/a483d1b5-64aa-45b6-86ef-11b859f7f02e">Memory-Mapped Files</related>
1870+
<related type="Article" href="~/docs/standard/io/memory-mapped-files.md">Memory-Mapped Files</related>
18681871
</Docs>
18691872
</Member>
18701873
<Member MemberName="OpenExisting">
@@ -1916,7 +1919,7 @@ Process C says: True
19161919
<exception cref="T:System.ArgumentOutOfRangeException">
19171920
<paramref name="desiredAccessRights" /> is not a valid <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedFileRights" /> enumeration value.</exception>
19181921
<exception cref="T:System.IO.FileNotFoundException">The file specified for <paramref name="mapName" /> does not exist.</exception>
1919-
<related type="Article" href="https://msdn.microsoft.com/library/a483d1b5-64aa-45b6-86ef-11b859f7f02e">Memory-Mapped Files</related>
1922+
<related type="Article" href="~/docs/standard/io/memory-mapped-files.md">Memory-Mapped Files</related>
19201923
</Docs>
19211924
</Member>
19221925
<Member MemberName="OpenExisting">
@@ -1976,7 +1979,7 @@ Process C says: True
19761979
<exception cref="T:System.UnauthorizedAccessException">The requested access is invalid for the memory-mapped file.</exception>
19771980
<exception cref="T:System.IO.FileNotFoundException">The file specified for <paramref name="mapName" /> does not exist.</exception>
19781981
<permission cref="T:System.Security.Permissions.SecurityPermission">for access to unmanaged code. Associated enumeration: <see cref="F:System.Security.Permissions.SecurityPermissionFlag.UnmanagedCode" />.</permission>
1979-
<related type="Article" href="https://msdn.microsoft.com/library/a483d1b5-64aa-45b6-86ef-11b859f7f02e">Memory-Mapped Files</related>
1982+
<related type="Article" href="~/docs/standard/io/memory-mapped-files.md">Memory-Mapped Files</related>
19801983
</Docs>
19811984
</Member>
19821985
<Member MemberName="SafeMemoryMappedFileHandle">
@@ -2019,7 +2022,7 @@ Process C says: True
20192022
<value>The handle to the memory-mapped file.</value>
20202023
<remarks>To be added.</remarks>
20212024
<permission cref="T:System.Security.Permissions.SecurityPermission">for access to unmanaged code. Associated enumeration: <see cref="F:System.Security.Permissions.SecurityPermissionFlag.UnmanagedCode" />.</permission>
2022-
<related type="Article" href="https://msdn.microsoft.com/library/a483d1b5-64aa-45b6-86ef-11b859f7f02e">Memory-Mapped Files</related>
2025+
<related type="Article" href="~/docs/standard/io/memory-mapped-files.md">Memory-Mapped Files</related>
20232026
</Docs>
20242027
</Member>
20252028
<Member MemberName="SetAccessControl">
@@ -2060,8 +2063,8 @@ Process C says: True
20602063
<exception cref="T:System.InvalidOperationException">An underlying call to set security information failed.</exception>
20612064
<exception cref="T:System.NotSupportedException">An underlying call to set security information failed.</exception>
20622065
<exception cref="T:System.UnauthorizedAccessException">An underlying call to set security information failed.</exception>
2063-
<related type="Article" href="https://msdn.microsoft.com/library/a483d1b5-64aa-45b6-86ef-11b859f7f02e">Memory-Mapped Files</related>
2066+
<related type="Article" href="~/docs/standard/io/memory-mapped-files.md">Memory-Mapped Files</related>
20642067
</Docs>
20652068
</Member>
20662069
</Members>
2067-
</Type>
2070+
</Type>

0 commit comments

Comments
 (0)