Skip to content

Update symlink documentation #7118

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.

Sign up for GitHub

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 2 commits into from
Sep 8, 2021
Merged

Update symlink documentation #7118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c6f8e10
Update symlink documentation
carlossanlop Sep 8, 2021
69aae27
Apply suggestions from code review
carlossanlop Sep 8, 2021
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
29 changes: 23 additions & 6 deletions xml/System.IO/Directory.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,7 +365,7 @@ Directory::CreateDirectory("c:\\Users\\User1\\Public\\Html");
<Parameter Name="pathToTarget" Type="System.String" Index="1" FrameworkAlternate="net-6.0" />
</Parameters>
<Docs>
<param name="path">The absolute path where the symbolic link should be created.</param>
<param name="path">The path where the symbolic link should be created.</param>
<param name="pathToTarget">The target directory of the symbolic link.</param>
<summary>Creates a directory symbolic link identified by <paramref name="path" /> that points to <paramref name="pathToTarget" />.</summary>
<returns>A <see cref="T:System.IO.DirectoryInfo" /> instance that wraps the newly created directory symbolic link.</returns>
Expand All @@ -374,10 +374,17 @@ Directory::CreateDirectory("c:\\Users\\User1\\Public\\Html");
<paramref name="path" /> or <paramref name="pathToTarget" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="path" /> or <paramref name="pathToTarget" /> is empty.
-or- <paramref name="path" /> is not an absolute path.
-or- <paramref name="path" /> or <paramref name="pathToTarget" /> contains invalid path characters.</exception>

-or-

<paramref name="path" /> or <paramref name="pathToTarget" /> contains invalid path characters.</exception>
<exception cref="T:System.IO.IOException">A file or directory already exists in the location of <paramref name="path" />.
-or- An I/O error occurred.</exception>

-or-

An I/O error occurred.</exception>
<related type="Article" href="https://docs.microsoft.com/en-us/windows/win32/fileio/symbolic-links">Windows Developer - Symbolic Links</related>
<related type="Article" href="https://docs.microsoft.com/en-us/windows/win32/fileio/reparse-points-and-file-operations">Windows Developer - Reparse Points and File Operations</related>
</Docs>
</Member>
<MemberGroup MemberName="Delete">
Expand Down Expand Up @@ -4092,11 +4099,21 @@ Directory::CreateDirectory("c:\\Users\\User1\\Public\\Html");

When `returnFinalTarget` is `true`, the maximum number of symbolic links that are followed are 40 on Unix and 63 on Windows.

Symbolic links and junctions are the types of links this API can resolve.

]]></format>
</remarks>
<exception cref="T:System.IO.IOException">The directory on <paramref name="linkPath" /> does not exist.
-or- The link's file system entry type is inconsistent with that of its target.
-or- Too many levels of symbolic links.</exception>

-or-

The link's file system entry type is inconsistent with that of its target.

-or-

There are too many levels of symbolic links.</exception>
<related type="Article" href="/windows/win32/fileio/symbolic-links">Windows Developer - Symbolic Links</related>
<related type="Article" href="/windows/win32/fileio/reparse-points-and-file-operations">Windows Developer - Reparse Points and File Operations</related>
</Docs>
</Member>
<Member MemberName="SetAccessControl">
Expand Down
26 changes: 22 additions & 4 deletions xml/System.IO/File.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1391,9 +1391,17 @@
<paramref name="path" /> or <paramref name="pathToTarget" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="path" /> or <paramref name="pathToTarget" /> is empty.
-or- <paramref name="path" /> or <paramref name="pathToTarget" /> contains a <see langword="null" /> character.</exception>

-or-

<paramref name="path" /> or <paramref name="pathToTarget" /> contains a <see langword="null" /> character.</exception>
<exception cref="T:System.IO.IOException">A file or directory already exists in the location of <paramref name="path" />.
-or- An I/O error occurred.</exception>

-or-

An I/O error occurred.</exception>
<related type="Article" href="/windows/win32/fileio/symbolic-links">Windows Developer - Symbolic Links</related>
<related type="Article" href="/windows/win32/fileio/reparse-points-and-file-operations">Windows Developer - Reparse Points and File Operations</related>
</Docs>
</Member>
<Member MemberName="CreateText">
Expand Down Expand Up @@ -4716,11 +4724,21 @@ The following example moves a file.

When `returnFinalTarget` is `true`, the maximum number of symbolic links that are followed are 40 on Unix and 63 on Windows.

Symbolic links and junctions are the types of links this API can resolve.

]]></format>
</remarks>
<exception cref="T:System.IO.IOException">The file on <paramref name="linkPath" /> does not exist.
-or- The link's file system entry type is inconsistent with that of its target.
-or- Too many levels of symbolic links.</exception>

-or-

The link's file system entry type is inconsistent with that of its target.

-or-

There are too many levels of symbolic links.</exception>
<related type="Article" href="/windows/win32/fileio/symbolic-links">Windows Developer - Symbolic Links</related>
<related type="Article" href="/windows/win32/fileio/reparse-points-and-file-operations">Windows Developer - Reparse Points and File Operations</related>
</Docs>
</Member>
<Member MemberName="SetAccessControl">
Expand Down
31 changes: 25 additions & 6 deletions xml/System.IO/FileSystemInfo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -361,10 +361,17 @@
<paramref name="pathToTarget" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="pathToTarget" /> is empty.
-or- This instance was not created passing an absolute path.
-or- <paramref name="pathToTarget" /> contains invalid path characters.</exception>

-or-

<paramref name="pathToTarget" /> contains invalid path characters.</exception>
<exception cref="T:System.IO.IOException">A file or directory already exists in the location of <see cref="P:System.IO.FileSystemInfo.FullName" />.
-or- An I/O error occurred.</exception>

-or-

An I/O error occurred.</exception>
<related type="Article" href="/windows/win32/fileio/symbolic-links">Windows Developer - Symbolic Links</related>
<related type="Article" href="/windows/win32/fileio/reparse-points-and-file-operations">Windows Developer - Reparse Points and File Operations</related>
</Docs>
</Member>
<Member MemberName="CreationTime">
Expand Down Expand Up @@ -1315,7 +1322,9 @@ The `Extension` property returns the <xref:System.IO.FileSystemInfo> extension,
<summary>If this <see cref="T:System.IO.FileSystemInfo" /> instance represents a link, returns the link target's path.
If a link does not exist in <see cref="P:System.IO.FileSystemInfo.FullName" />, or this instance does not represent a link, returns <see langword="null" />.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>Symbolic links and junctions are the types of links this API can resolve.</remarks>
<related type="Article" href="/windows/win32/fileio/symbolic-links">Windows Developer - Symbolic Links</related>
<related type="Article" href="/windows/win32/fileio/reparse-points-and-file-operations">Windows Developer - Reparse Points and File Operations</related>
</Docs>
</Member>
<Member MemberName="Name">
Expand Down Expand Up @@ -1530,11 +1539,21 @@ Call `Refresh` before attempting to get the attribute information, or the inform

When `returnFinalTarget` is `true`, the maximum number of symbolic links that are followed are 40 on Unix and 63 on Windows.

Symbolic links and junctions are the types of links this API can resolve.

]]></format>
</remarks>
<exception cref="T:System.IO.IOException">The file or directory does not exist.
-or- The link's file system entry type is inconsistent with that of its target.
-or- Too many levels of symbolic links.</exception>

-or-

The link's file system entry type is inconsistent with that of its target.

-or-

There are too many levels of symbolic links.</exception>
<related type="Article" href="/windows/win32/fileio/symbolic-links">Windows Developer - Symbolic Links</related>
<related type="Article" href="/windows/win32/fileio/reparse-points-and-file-operations">Windows Developer - Reparse Points and File Operations</related>
</Docs>
</Member>
<Member MemberName="ToString">
Expand Down