MACROMEDIA DREAMWEAVER MX 2004-DREAMWEAVER API, Reference

Page: 119 / 486

The Source Control Integration API required functions 119
Returns
A Boolean value:
true
if successful;
false
otherwise.
bool SCS_Connect()
Description
This function connects the user to the source control system. If the DLL does not have log-in
information, the DLL must display a dialog box to prompt the user for the information and must
store the data for later use.
Arguments
void **connectionData
,
const char siteName[64]
•
The
connectionData
argument is a handle to the data that the agent wants Dreamweaver to
pass to it when calling other API functions.
•
The
siteName
argument is a string that points to the name of the site. The site name can be a
maximum of 64 characters.
Returns
A Boolean value:
true
if successful;
false
otherwise.
bool SCS_Disconnect()
Description
This function disconnects the user from the source control system.
Arguments
void *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.
bool SCS_IsConnected()
Description
This function determines the state of the connection.
Arguments
void *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.
000_DW_API_Print.book Page 119 Wednesday, August 20, 2003 9:14 AM