Bool scs_getconnectioninfo(), Bool scs_sitedeleted(), Bool scs_siterenamed() – Adobe Dreamweaver API Reference CS5 User Manual
Page 98

93
DREAMWEAVER API REFERENCE
The source control integration API
Last updated 8/27/2013
bool SCS_GetConnectionInfo()
Description
This function displays a dialog box to let the user change or set the connection information for this site. It does not
make the connection. This function is called when the user clicks the Settings button in the Remote Info section of the
Edit Sites dialog box.
Arguments
void **connectionData, const char siteName[64]
•
The connectionData argument is a handle to data that the agent wants Dreamweaver to pass when calling other API
functions.
•
The siteName argument is a string that points to the name of the site. The name cannot exceed 64 characters.
Returns
A Boolean value:
true
if successful;
false
otherwise.
bool SCS_SiteDeleted()
Description
This function notifies the DLL that the site has been deleted or that the site is no longer tied to this source control
system. It indicates that the source control system can delete its persistent information for this site.
Arguments
const char siteName[64]
•
The siteName argument is a string that points to the name of the site. The name cannot exceed 64 characters.
Returns
A Boolean value:
true
if successful;
false
otherwise.
bool SCS_SiteRenamed()
Description
This function notifies the DLL when the user has renamed the site so that it can update its persistent information about
the site.
Arguments
const char oldSiteName[64], const char newSiteName[64]
•
The oldSiteName argument is a string that points to the original name of the site before it was renamed. The name
cannot exceed 64 characters.
•
The newSiteName argument is a string that points to the new name of the site after it was renamed. The name
cannot exceed 64 characters.
Returns
A Boolean value:
true
if successful;
false
otherwise.