Adobe Dreamweaver API Reference CS5 - Manual (Page 100)

95 DREAMWEAVER API REFERENCE
The source control integration API
Last updated 8/27/2013
Arguments
void *connectionData, char checkOutName[64], char emailAddress[64]
• The connectionData argument is a pointer to the agent’s data that passed into Dreamweaver during the Connect() call.
• The checkOutName argument is the name of the current user.
• The emailAddress argument is the e-mail address of the current user.
Returns
A Boolean value:
true if successful; false otherwise.
bool SCS_Checkin()
Description
This function checks a list of local files or folders into the source control system. The DLL is responsible for making
the file read-only. If it is unsupported by the source control system and this feature is enabled by the user, this function
uses the Dreamweaver internal Check In/Check Out functionality, which transports LCK files to and from the source
control system.
Arguments
void *connectionData, const char *localPathList[], const char *remotePathList[], bool successList[], const int numItems
• The connectionData argument is a pointer to the agent’s data that passed into Dreamweaver during the Connect() call.
• The localPathList argument is a list of local filenames or folder paths to check in.
• The remotePathList argument is a mirrored list of remote filenames or folder paths.
• The successList argument is a list of Boolean values that are populated by the DLL to let Dreamweaver know which
of the corresponding files are checked in successfully.
• The numItems argument is the number of items in each list.
Returns
A Boolean value:
true if successful; false otherwise.
bool SCS_Checkout()
Description
This function checks out a list of local files or folders from the source control system. The DLL is responsible for
granting the privileges that let the file be writable. If it is unsupported by the source control system and this feature is
enabled by the user, this function uses the Dreamweaver internal Check In/Check Out functionality, which transports
LCK files to and from the source control system.
Arguments
void *connectionData, const char *remotePathList[], const char *localPathList[], bool successList[], const int numItems
• The connectionData argument is a pointer to the agent’s data that passed into Dreamweaver during the Connect() call.
• The remotePathList argument is a list of remote filenames or folder paths to check out.
• The localPathList argument is a mirrored list of local filenames or folder paths.