Rename method of the CIM_LogicalFile class

The Rename method renames the logical file (or directory) specified in the object path. Renaming is not supported if the destination is on another drive, or overwriting an existing logical file is required.

Important

The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.

This topic uses Managed Object Format (MOF) syntax. For more information about using this method, see Calling a Method.

Syntax

uint32 Rename(
  [in] string FileName
);

Parameters

FileName [in]

Fully qualified new file (or directory) name.

Example: "c:\temp\newfile.txt"

Return value

Returns a value of 0 (zero) on success, and any other number to indicate an error.

Success

0

Success.

Access Denied

2

Access denied.

Unspecified failure

8

Unspecified failure.

Invalid object

9

Invalid object.

Object already exists

10

Object already exists.

File system not NTFS

11

File system not NTFS.

Platform not NT/Windows 2000

12

Platform not Windows.

Drive not the same

13

Drive not the same.

Directory not empty

14

Directory not empty.

Sharing violation

15

Sharing violation.

Invalid start file

16

Invalid start file.

Privilege not held

17

Privilege not held.

Invalid parameter

21

Invalid parameter.

Remarks

This method is currently not implemented by WMI. To use this method, you must implement it in your own provider.

This documentation is derived from the CIM class descriptions published by the DMTF. Microsoft may have made changes to correct minor errors, conform to Microsoft SDK documentation standards, or provide more information.

Requirements

Requirement Value
Minimum supported client
Windows Vista
Minimum supported server
Windows Server 2008
Namespace
Root\CIMV2
MOF
CIMWin32.mof
DLL
CIMWin32.dll

See also

CIM_LogicalFile

CIM_LogicalFile