PrlSrv_FsRenameEntry Function

Renames a file system entry on the host.

Syntax

PRL_HANDLE PrlSrv_FsRenameEntry(
    PRL_HANDLE hServer, 
    PRL_CONST_STR oldPath, 
    PRL_CONST_STR newPath
);

File

PrlApi.h

Parameters

hServer

A handle of type PHT_SERVER identifying the Parallels Service.

oldPath

An absolute path to the entry to be renamed.

newPath

An absolute path including the new file system entry name.

Returns

A handle of type PHT_JOB containing the results of this asynchronous operation or PRL_INVALID_HANDLE if there's not enough memory to instantiate the job object.

Remarks

To get the return code from the PHT_JOB object, use the PrlJob_GetRetCode function. Possible values are:

PRL_ERR_INVALID_ARG - invalid handle was passed.

PRL_ERR_SUCCESS - function completed successfully.

Links

PrlApi.h, PHT_SERVER