Specifications

The Source Control Integration API 357
Arguments
char menuItemList[][32], scFunction functionList[], scFunction enablerList[],
const int numNewFeatures
• menuItemList is a string list that is populated by the DLL; it specifies the menu items to add
to the main and context menus. Each string can contain a maximum of 32 characters.
• functionList is populated by the DLL; it specifies the routines in the DLL to call when the
user chooses the corresponding menu item.
• enablerList is populated by the DLL; it specifies the routines in the DLL to call when
Dreamweaver needs to determine whether the corresponding menu item is enabled.
• numNewFeatures is the number of items being added by the DLL; this value is retrieved from
the
GetNumNewFeatures() call.
The following function signature defines the functions and enablers that passed to the
SCS_GetNewFeatures() call in the functionlist and enablerList arguments.
bool (*scFunction)(void *connectionData, const char *remotePathList[],
const char *localPathList[], const int numItems)
Returns
true if successful; false otherwise.
bool SCS_GetCheckoutName()
Description
Returns the check-out name of the current user. If it is unsupported by the source control system
and this feature is enabled by the user, this function uses the Dreamweaver internal Check in/
Check out functionality, which transports .lck files to and from the source control system.
Arguments
void *connectionData, char checkOutName[64], char emailAddress[64]
• connectionData is a pointer to the agent’s data that passed into Dreamweaver during the
Connect() call.
• checkOutName is the check-out name of the current user.
• emailAddress is the e-mail address of the current user.
Returns
true if successful; false otherwise.
bool SCS_Checkin()
Description
Checks a list of local files or folders into the source control system. The DLL is responsible for
making the file read-only. If it is unsupported by the source control system and this feature is
enabled by the user, this function uses the Dreamweaver internal Check in/Check out
functionality, which transports .lck files to and from the source control system.