Adobe Dreamweaver API Reference CS5 - Manual (Page 94)

89 DREAMWEAVER API REFERENCE
The source control integration API
Last updated 8/27/2013
Returns
An integer that indicates the length of the name of the root folder. If the function returns
< 0 , Dreamweaver considers
it an error and tries to retrieve the error message from the DLL, if supported.
bool SCS_GetRootFolder()
Description
This function returns the name of the root folder.
Arguments
void *connectionData, char remotePath[], const int folderLen
• The connectionData argument is a pointer to the agent’s data that passed into Dreamweaver during the Connect() call.
• The remotePath is a buffer where the full remote path of the root folder is stored.
• The folderLen argument is an integer that indicates the length of remotePath. This is the value that
GetRootFolderLength returns.
Returns
A Boolean value:
true if successful; false otherwise.
int SCS_GetFolderListLength()
Description
This function returns the number of items in the passed-in folder.
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 full path and name of the remote folder that the DLL checks for the number of
items.
Returns
An integer that indicates the number of items in the current folder. If the function returns
< 0 , Dreamweaver considers
it an error and tries to retrieve the error message from the DLL, if supported.
bool SCS_GetFolderList()
Description
This function returns a list of files and folders in the passed-in folder, including pertinent information such as
modified date, size, and whether the item is a folder or file.
Arguments
void *connectionData, const char *remotePath, itemInfo itemList[], const int numItems
• The connectionData argument is a pointer to the agent’s data that passed into Dreamweaver during the Connect() call.