Name

VMRenameFileInGuest

Description

$err = VMRenameFileInGuest($vmHandle,
                           $oldName,
                           $newName,
                           $options,
                           $propertyListHandle);

This function renames a file or directory in the guest operating system.

Parameters

vmHandle
Identifies a virtual machine. Call VMOpen() to create a virtual machine handle.
oldName
The path to the file to be renamed.
newName
The path to the new file.
options
Must be 0.
propertyListHandle
Must be VIX_INVALID_HANDLE.

Return Value

$err. The error code returned by the operation. For returned values, see Topics > Error Codes.

Remarks

Side Effects

None.

Requirements

use VMware::Vix::Simple;
use VMware::Vix::API::Constants;
since VMware Workstation 6.0
Minimum Supported Guest OS: Microsoft Windows NT Series, Linux

Copyright (C) 2007-2011 VMware, Inc. All rights reserved.