Specifications

The Source Control Integration API 359
Arguments
void *connectionData, const char *remotePathList[], const char *localPathList[],
bool successList[], const int numItems
• connectionData is a pointer to the agent’s data that passed into Dreamweaver during the
Connect() call.
• remotePathList is a list of remote file or folder path names on which to undo the check out.
• localPathList is a mirrored list of local file or folder path names.
• successList is a list of Boolean values that are populated by the DLL to let Dreamweaver
know which corresponding files’ check outs are successfully undone.
• numItems is the number of items in each list.
Returns
true if successful; false otherwise.
int SCS_GetNumCheckedOut()
Description
Returns the number of people who have a file checked out.
Arguments
void *connectionData, const char *remotePath
• connectionData is a pointer to the agent’s data that passed into Dreamweaver during the
Connect() call.
• remotePath is the remote file or folder path name 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.
bool SCS_GetFileCheckoutList()
Description
Returns a list of people who have a file checked out. If the list is empty, no one has the file
checked out.
Arguments
void *connectionData, const char *remotePath, char checkOutList[][64], char
emailAddressList[][64], const int numCheckedOut
• connectionData is a pointer to the agent’s data that passed into Dreamweaver during the
Connect() call.
• remotePath is the remote file or folder path name to check how many users have it checked
out.
• checkOutList is a list of strings that corresponds to the users who have the file checked out.
Each user string cannot exceed a maximum length of 64 characters.