# Name

VixVM_RenameFileInGuest

# Description

    VixHandle
    VixVM_RenameFileInGuest(VixHandle vmHandle,
                            const char *oldName,
                            const char *newName,
                            int options,
                            VixHandle propertyListHandle,
                            VixEventProc *callbackProc,
                            void *clientData);

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

# Parameters

vmHandle
  Identifies a virtual machine. Call VixVM_Open() 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.
callbackProc
  A callback function that will be invoked when the operation is complete.
clientData
  A parameter that will be passed to the callbackProc function.

# Return Value

VixHandle. A job handle that describes the state of this asynchronous operation.

# Remarks

- You must call VixVM_LoginInGuest() before calling this function.
- Only absolute paths should be used for files in the guest; the resolution of relative paths is not specified.
- On Windows guests, it fails on directory moves when the destination is on a different volume.
- Because of the differences in how various operating systems handle filenames, Vix may return either VIX_E_INVALID_ARG or VIX_E_FILE_NAME_TOO_LONG for filenames longer than 255 characters.

# Side Effects

None.

# Requirements

vix.h, since VMware Workstation 6.0
Minimum Supported Guest OS: Microsoft Windows NT Series, Linux

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