DriveInfo.VolumeLabel Property

Reference

Definition

Namespace:: System.IO

Assembly:: System.IO.FileSystem.DriveInfo.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Source:: DriveInfo.UnixOrDefault.cs

Source:: DriveInfo.UnixOrDefault.cs

Source:: DriveInfo.UnixOrDefault.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the volume label of a drive.

public:
 property System::String ^ VolumeLabel { System::String ^ get(); void set(System::String ^ value); };

public string VolumeLabel { get; [System.Runtime.Versioning.SupportedOSPlatform("windows")] set; }

public string VolumeLabel { get; set; }

[<set: System.Runtime.Versioning.SupportedOSPlatform("windows")>]
member this.VolumeLabel : string with get, set

member this.VolumeLabel : string with get, set

Public Property VolumeLabel As String

Property Value

String

The volume label.

Attributes: SupportedOSPlatformAttribute

Exceptions

IOException

An I/O error occurred (for example, a disk error or a drive was not ready).

DriveNotFoundException

The drive is not mapped or does not exist.

SecurityException

The caller does not have the required permission.

UnauthorizedAccessException

The volume label is being set on a network or CD-ROM drive.

-or-

Access to the drive information is denied.

Examples

The following example demonstrates the use of the DriveInfo class to display information about all the drives on the current system.

using System;
using System.IO;

class Test
{
    public static void Main()
    {
        DriveInfo[] allDrives = DriveInfo.GetDrives();

        foreach (DriveInfo d in allDrives)
        {
            Console.WriteLine("Drive {0}", d.Name);
            Console.WriteLine("  Drive type: {0}", d.DriveType);
            if (d.IsReady)
            {
                Console.WriteLine("  Volume label: {0}", d.VolumeLabel);
                Console.WriteLine("  File system: {0}", d.DriveFormat);
                Console.WriteLine(
                    "  Available space to current user:{0, 15} bytes",
                    d.AvailableFreeSpace);

                Console.WriteLine(
                    "  Total available space:          {0, 15} bytes",
                    d.TotalFreeSpace);

                Console.WriteLine(
                    "  Total size of drive:            {0, 15} bytes ",
                    d.TotalSize);
            }
        }
    }
}
/*
This code produces output similar to the following:

Drive A:\
  Drive type: Removable
Drive C:\
  Drive type: Fixed
  Volume label:
  File system: FAT32
  Available space to current user:     4770430976 bytes
  Total available space:               4770430976 bytes
  Total size of drive:                10731683840 bytes
Drive D:\
  Drive type: Fixed
  Volume label:
  File system: NTFS
  Available space to current user:    15114977280 bytes
  Total available space:              15114977280 bytes
  Total size of drive:                25958948864 bytes
Drive E:\
  Drive type: CDRom

The actual output of this code will vary based on machine and the permissions
granted to the user executing it.
*/

Imports System.IO

Class Test
    Public Shared Sub Main()
        Dim allDrives() As DriveInfo = DriveInfo.GetDrives()

        Dim d As DriveInfo
        For Each d In allDrives
            Console.WriteLine("Drive {0}", d.Name)
            Console.WriteLine("  Drive type: {0}", d.DriveType)
            If d.IsReady = True Then
                Console.WriteLine("  Volume label: {0}", d.VolumeLabel)
                Console.WriteLine("  File system: {0}", d.DriveFormat)
                Console.WriteLine( _
                    "  Available space to current user:{0, 15} bytes", _
                    d.AvailableFreeSpace)

                Console.WriteLine( _
                    "  Total available space:          {0, 15} bytes", _
                    d.TotalFreeSpace)

                Console.WriteLine( _
                    "  Total size of drive:            {0, 15} bytes ", _
                    d.TotalSize)
            End If
        Next
    End Sub
End Class
'This code produces output similar to the following:
'
'Drive A:\
'  Drive type: Removable
'Drive C:\
'  Drive type: Fixed
'  Volume label: 
'  File system: FAT32
'  Available space to current user:     4770430976 bytes
'  Total available space:               4770430976 bytes
'  Total size of drive:                10731683840 bytes 
'Drive D:\
'  Drive type: Fixed
'  Volume label: 
'  File system: NTFS
'  Available space to current user:    15114977280 bytes
'  Total available space:              15114977280 bytes
'  Total size of drive:                25958948864 bytes 
'Drive E:\
'  Drive type: CDRom
'
'The actual output of this code will vary based on machine and the permissions
'granted to the user executing it.

Remarks

The label length is determined by the operating system. For example, NTFS allows a volume label to be up to 32 characters long. Note that null is a valid VolumeLabel.

Applies to

Share via