Adobe Dreamweaver API Reference CS5 - Manual (Page 97)

92 DREAMWEAVER API REFERENCE
The source control integration API
Last updated 8/27/2013
bool SCS_Rename()
Description
This function renames or moves a file or folder, depending on the values that are specified for oldRemotePath and
newRemotePath. For example, if oldRemotePath equals
"$/folder1/file1" and newRemotePath equals
"$/folder1/renamefile1" , file1 is renamed renamefile1 and is located in folder1.
If oldRemotePath equals "$/folder1/file1" and newRemotePath equals "$/folder1/subfolder1/file1" , file1 is
moved to the subfolder1 folder.
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
void *connectionData, const char *oldRemotePath, const char *newRemotePath
• The connectionData argument is a pointer to the agent’s data that passed into Dreamweaver during the Connect() call.
• The oldRemotePath argument is a remote file or folder path to rename.
• The newRemotePath argument is the remote path of the new name for the file or folder.
Returns
A Boolean value:
true if successful; false otherwise.
bool SCS_ItemExists()
Description
This function determines whether a file or folder exists on the server.
Arguments
void *connectionData, const char *remotePath
• The connectionData argument is a pointer to the agent’s data that passed into Dreamweaver during the Connect() call.
• The remotePath argument is a remote file or folder path.
Returns
A Boolean value:
true if successful; false otherwise.
The source control integration API optional functions
The source control integration API has required and optional functions. The functions in this section are optional.