Adobe 38040334 API Reference - Page 100

DREAMWEAVER CS3 95 API Reference • 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. 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.