beautypg.com

Bool scs_canget(), Bool scs_cancheckout(), Bool scs_canput() – Adobe Dreamweaver API Reference CS5 User Manual

Page 106

background image

101

DREAMWEAVER API REFERENCE

The source control integration API

Last updated 8/27/2013

bool SCS_canGet()

Description
This function returns whether the Get 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 get.

The localPathList argument is a mirrored list of local 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_canCheckout()

Description
This function returns whether the 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 mirrored list of local 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_canPut()

Description
This function returns whether the Put 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 put into the source control system.

The remotePathList argument is a mirrored list of remote filenames or folder paths to put into the source control
system.

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