CFLib.org – Common Function Library Project

SetVolumeName(drvPath, newName)

Last updated August 02, 2001

author

Rob Brooks-Bilson

Version: 1 | Requires: CF5 | Library: FileSysLib

Description:
Sets the volume name for the specified drive. Because this function uses COM, it is only supported in the Windows version of ColdFusion.

Return Values:
Returns True.

Example:

Because this function modifies the volume name of an actual drive on the server, no live example is provided.  For example code, see the header comments in the library.

Parameters:

Name Description Required
drvPath Drive letter (c, c:, c:\) or network share (\\computer\share). Yes
newName New volume name for the drive. Yes

Full UDF Source:

/**
 * Sets the volume name for the specified drive. (Windows only)
 * Sample code: 
 * <CFSET SetVolumeName("c", "System")>
 * 
 * @param drvPath      Drive letter (c, c:, c:\) or network share (\\computer\share). 
 * @param newName      New volume name for the drive. 
 * @return Returns True. 
 * @author Rob Brooks-Bilson (rbils@amkor.com) 
 * @version 1, August 2, 2001 
 */
function SetVolumeName(drvPath, newName)
{
  Var fso  = CreateObject("COM", "Scripting.FileSystemObject");
  Var drive = fso.GetDrive(drvPath);
  drive.VolumeName = newName;
  Return True;
}

Search CFLib.org


Latest Additions

Raymond Camden added
QueryDeleteRows
November 04, 2017

Leigh added
nullPad
May 11, 2016

Raymond Camden added
stripHTML
May 10, 2016

Kevin Cotton added
date2ExcelDate
May 05, 2016

Raymond Camden added
CapFirst
April 25, 2016

Created by Raymond Camden / Design by Justin Johnson