This documentation is archived and is not being maintained.

DriveInfo.VolumeLabel Property

Note: This property is new in the .NET Framework version 2.0.

Gets or sets the volume label of a drive.

Namespace: System.IO
Assembly: mscorlib (in mscorlib.dll)

public string VolumeLabel { get; set; }
/** @property */
public String get_VolumeLabel ()

/** @property */
public void set_VolumeLabel (String value)

public function get VolumeLabel () : String

public function set VolumeLabel (value : String)

Property Value

The volume label.

Exception typeCondition

IOException

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

SecurityException

The caller does not have the required permission.

UnauthorizedAccessException

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

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 a null reference (Nothing in Visual Basic) is a valid VolumeLabel.

The following code example demonstrates the use of the DriveInfo class to display information about all of 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("  File type: {0}", d.DriveType);
            if (d.IsReady == true)
            {
                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:\
  File type: Removable
Drive C:\
  File 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:\
  File 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:\
  File type: CDRom

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

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0
Show: