MACROMEDIA DREAMWEAVER 8-DREAMWEAVER API, Reference

Page: 121 / 628

The Source Control Integration API required functions 121
Arguments
void *connectionData
■
The
connectionData
argument is a pointer to the agent’s data that passed into
Dreamweaver during the
Connect()
call.
Returns
A Boolean value:
true
if successful;
false
otherwise.
int SCS_GetRootFolderLength()
Description
This function returns the length of the name of the root folder.
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 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.
000_DW_API_Print.book Page 121 Wednesday, July 20, 2005 11:58 AM