The Source Control Integration API > The source control integration API optional functions > 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
connectionData, remotePath, checkOutList, emailAddressList, numCheckedOut
connectionData is a pointer to the agent's data that was passed into Dreamweaver during the Connect() call. |
|
remotePath is the fully qualified remote file or folder path to check to see how many users have it checked out. |
|
checkOutList is a list of strings corresponding to the users who have the file checked out. Each user string cannot exceed a maximum length of 64 characters. |
|
emailAddressList is a list of strings corresponding to the users' email addresses. Each email address string cannot exceed a maximum length of 64 characters. |
|
numCheckedOut is the number of people who have the file checked out. This is returned from GetNumCheckedOut(). |
Returns
true if successful, false if not.