beautypg.com

Int scs_getnumnewfeatures(), Bool scs_getnewfeatures(), Bool scs_getcheckoutname() – Adobe Dreamweaver API Reference CS5 User Manual

Page 99

background image

94

DREAMWEAVER API REFERENCE

The source control integration API

Last updated 8/27/2013

int SCS_GetNumNewFeatures()

Description
This function returns the number of new features to add to Dreamweaver (for example, File History, Differences, and
so on).

Arguments
None.

Returns
An integer that indicates the number of new features to add to Dreamweaver. If the function returns

< 0

,

Dreamweaver considers it an error and tries to retrieve the error message from the DLL, if supported.

bool SCS_GetNewFeatures()

Description
This function returns a list of menu items to add to the Dreamweaver main and context menus. For example, the
Sourcesafe DLL can add History and File Differences to the main menu.

Arguments
char menuItemList[][32], scFunction functionList[], scFunction enablerList[], const int numNewFeatures

The menuItemList argument 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.

The functionList argument is populated by the DLL; it specifies the routines in the DLL to call when the user selects
the corresponding menu item.

The enablerList argument 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.

The numNewFeatures argument 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
A Boolean value:

true

if successful;

false

otherwise.

bool SCS_GetCheckoutName()

Description
This function 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.