Skip to content

Modernize GetLogicalDrives docs #10376

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 1 commit into from
Oct 10, 2024
Merged

Modernize GetLogicalDrives docs #10376

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions xml/System.IO/Directory.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4055,13 +4055,13 @@ The returned collection is not cached. Each call to the <xref:System.Collections
</ReturnValue>
<Parameters />
<Docs>
<summary>Retrieves the names of the logical drives on this computer in the form "&lt;drive letter&gt;:\\".</summary>
<returns>The logical drives on this computer.</returns>
<summary>Retrieves the names of the logical drives on this computer.</summary>
<returns>An array of strings representing the logical drive names.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
GetLogicalDrives returns all of the accessible drives on a particular machine, including the floppy drive and any optical drives.
On Windows, `GetLogicalDrives` returns the names of all accessible drives on a particular machine, including any optical drives or removable media devices, in the form "\<drive letter\>:\\" (for example, "C:\\"). On Unix, it returns the paths of all filesystem mount points mounted on a particular machine (for example, "/home/user", "/media/usb").

For a list of common I/O tasks, see [Common I/O Tasks](/dotnet/standard/io/common-i-o-tasks).

Expand Down
7 changes: 5 additions & 2 deletions xml/System/Environment.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1421,11 +1421,14 @@ The following example creates environment variables for the <xref:System.Environ
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns an array of string containing the names of the logical drives on the current computer.</summary>
<returns>An array of strings where each element contains the name of a logical drive. For example, if the computer's hard drive is the first logical drive, the first element returned is "C:\\".</returns>
<summary>Retrieves the names of the logical drives on this computer.</summary>
<returns>An array of strings representing the logical drive names.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
On Windows, `GetLogicalDrives` returns the names of all accessible drives on a particular machine, including any optical drives or removable media devices, in the form "\<drive letter\>:\\" (for example, "C:\\"). On Unix, it returns the paths of all filesystem mount points mounted on a particular machine (for example, "/home/user", "/media/usb").

## Examples
The following example shows how to display the logical drives of the current computer using the <xref:System.Environment.GetLogicalDrives%2A> method.

Expand Down