User Guide

The Source Control Integration API optional functions 129
bool SCS_GetFileCheckoutList()
Description
This function returns a list of users 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
• 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 how many users have it
checked out.
• The checkOutList argument 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.
• The emailAddressList argument is a list of strings that corresponds to the users’ e-mail
addresses. Each e-mail address string cannot exceed a maximum length of 64 characters.
• The numCheckedOut argument is the number of people who have the file checked out. This is
returned from
GetNumCheckedOut().
Returns
A Boolean value: true if successful; false otherwise.
int SCS_GetErrorMessageLength()
Description
This function returns the length of the DLL’s current internal error message. This allocates the
buffer that passes into the
GetErrorMessage() function. This function should be called only if
an API function returns
false or <0, which indicates a failure of that API function.
Arguments
void *connectionData
• The connectionData argument is a pointer to the agent’s data that passed into Dreamweaver
during the Connect() call.
Returns
An integer that represents the length of the error message.
000_DW_API_Print.book Page 129 Wednesday, August 20, 2003 9:14 AM