beautypg.com

Bool scs_cancheckin(), Bool scs_canundocheckout(), Bool scs_cannewfolder() – Adobe Dreamweaver API Reference CS5 User Manual

Page 107

background image

102

DREAMWEAVER API REFERENCE

The source control integration API

Last updated 8/27/2013

Returns
A Boolean value:

true

if successful;

false

otherwise.

bool SCS_canCheckin()

Description
This function returns whether the Checkin menu item should be enabled.

Arguments
void *connectionData, const char *localPathList[], const char *remotePathList[], const int numItems

The connectionData argument is a pointer to the agent’s data that passed into Dreamweaver during the

Connect()

call.

The localPathList argument is a list of local filenames or folder paths to check in.

The remotePathList argument is a mirrored list of remote filenames or folder paths.

The numItems argument is the number of items in each list.

Returns
A Boolean value:

true

if successful;

false

otherwise.

bool SCS_CanUndoCheckout()

Description
This function returns whether the Undo Checkout menu item should be enabled.

Arguments
void *connectionData, const char *remotePathList[], const char *localPathList[], const int numItems

The connectionData argument is a pointer to the agent’s data that passed into Dreamweaver during the

Connect()

call.

The remotePathList argument is a list of remote filenames or folder paths to check out.

The localPathList argument is a list of the local filenames or folder paths to put to the source control system.

The numItems argument is the number of items in each list.

Returns
A Boolean value:

true

if successful;

false

otherwise.

bool SCS_canNewFolder()

Description
This function returns whether the New Folder menu item should be enabled.

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.