MACROMEDIA DREAMWEAVER MX 2004-DREAMWEAVER API, Reference

Page: 136 / 486

136 Chapter 10: The Source Control Integration API
Returns
A Boolean value:
true
if successful;
false
otherwise.
bool SCS_canRename()
Description
This function returns whether the Rename menu item should be enabled.
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
remotePathList
argument is the remote filenames or folder paths that can be renamed.
Returns
A Boolean value:
true
if successful;
false
otherwise.
bool SCS_BeforeGet()
Description
Dreamweaver calls this function before getting or checking out one or more files. This function
lets your DLL perform one operation, such as adding a check-out comment, to a group of files.
Arguments
*connectionData
•
The
*connectionData
argument is a pointer to the agent’s data that passed into
Dreamweaver during the
Connect()
call.
Returns
A Boolean value:
true
if successful;
false
otherwise.
Example
To get a group of files, Dreamweaver makes calls to the DLL in the following order:
SCS_BeforeGet(connectionData);
SCS_Get(connectionData,remotePathList1,localPathList1,¬
successList1);
SCS_Get(connectionData,remotePathList2,localPathList2,¬
successList2);
SCS_Get(connectionData,remotePathList3,localPathList3,¬
successList3);
SCS_AfterGet(connectionData);
000_DW_API_Print.book Page 136 Wednesday, August 20, 2003 9:14 AM