The Source Control Integration API > The source control integration API required functions > SCS_Rename() |
Description
Renames or moves a file or folder depending on the values specified for oldRemotePath and newRemotePath. For example, if oldRemotePath equals "$/folder1/file1" and newRemotePath equals "$/folder1/renamefile1", file1 is renamed to renamefile1 and is located in folder1.
If oldRemotePath equals "$/folder1/file1" and newRemotePath equals "$/folder1/subfolder1/file1", file1 is moved to the subfolder1 directory.
To find out if an invocation of this function is a move or a rename, check the parent paths of the two input values; if they are the same, the operation is a rename.
Arguments
connectionData, oldRemotePath, newRemotePath
connectionData is a pointer to the agent's data that was passed into Dreamweaver during the Connect() call. |
|
oldRemotePath is a fully qualified remote file or folder path to rename. |
|
newRemotePath is the fully qualified remote path of the new name for the file or folder. |
Returns
true if successful, false if not.