Adobe Dreamweaver API Reference CS5 - Manual (Page 101)

96 DREAMWEAVER API REFERENCE
The source control integration API
Last updated 8/27/2013
• 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 out successfully.
• The numItems argument is the number of items in each list.
Returns
A Boolean value:
true if successful; false otherwise.
bool SCS_UndoCheckout()
Description
This function undoes the check-out status of a list of files or folders. 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 *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 on which to undo the check out.
• The localPathList argument is a mirrored list of local filenames or folder paths.
• The successList argument is a list of Boolean values that are populated by the DLL to let Dreamweaver know which
corresponding files’ check outs are undone successfully.
• The numItems argument is the number of items in each list.
Returns
A Boolean value:
true if successful; false otherwise.
int SCS_GetNumCheckedOut()
Description
This function returns the number of users who have a file checked out.
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 the remote file or folder path to check to see how many users have it checked out.
Returns
An integer that indicates the number of people who have the file checked out. If the function returns
< 0 ,
Dreamweaver considers it an error and tries to retrieve the error message from the DLL, if supported.