beautypg.com

Bool scs_disconnect(), Bool scs_isconnected(), Int scs_getrootfolderlength() – Adobe Dreamweaver API Reference CS5 User Manual

Page 93

background image

88

DREAMWEAVER API REFERENCE

The source control integration API

Last updated 8/27/2013

Arguments
void **connectionData, const char siteName[64]

The connectionData argument is a handle to the data that the agent wants Dreamweaver to pass to it when calling
other API functions.

The siteName argument is a string that points to the name of the site. The site name can be a maximum of 64
characters.

Returns
A Boolean value:

true

if successful;

false

otherwise.

bool SCS_Disconnect()

Description
This function disconnects the user from the source control system.

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.

bool SCS_IsConnected()

Description
This function determines the state of the connection.

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.