Enablers

If the optional enablers are not supported by the source control system or the application is not connected to the server, Dreamweaver determines when the menu items are enabled, based on the information it has about the remote files.

bool SCS_canConnect()

Description

This function returns whether the Connect menu item should be enabled.

Arguments

None.

Returns

A Boolean value: TRue if successful; false otherwise.

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.

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.

• The remotePath argument is a list of remote filenames or folder paths that the user selected to indicate where the new folder will be created.

Returns

A Boolean value: TRue if successful; false otherwise.

bool SCS_canDelete()

Description

This function returns whether the Delete menu item should be enabled.

Arguments

 void *connectionData, 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 remotePathList argument is a list of remote filenames or folder paths to delete.

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

Returns

A Boolean value: true if successful; false otherwise.

bool SCS_canRename()

Description

This function returns whether the Rename 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.

• The remotePathList argument is the remote filenames or folder paths that can be renamed.

Returns

A Boolean value: true if successful; false otherwise.

bool SCS_BeforeGet()

Description

Dreamweaver calls this function before getting or checking out one or more files. This function lets your DLL perform one operation, such as adding a check-out comment, to a group of files.

Arguments

 *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.

Example

To get a group of files, Dreamweaver makes calls to the DLL in the following order:

 SCS_BeforeGet(connectionData); SCS_Get(connectionData,remotePathList1,localPathList1, successList1); SCS_Get(connectionData,remotePathList2,localPathList2, successList2); SCS_Get(connectionData,remotePathList3,localPathList3, successList3); SCS_AfterGet(connectionData); 

bool SCS_BeforePut()

Description

Dreamweaver calls this function before putting or checking in one or more files. This function lets your DLL perform one operation, such as adding a check-in comment, to a group of files.

Arguments

 *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.

Example

To get a group of files, Dreamweaver makes calls to the DLL in the following order:

 SCS_BeforePut(connectionData); SCS_Put(connectionData,localPathList1,remotePathList1, successList1); SCS_Put(connectionData,localPathList2,remotePathList2, successList2); SCS_Put(connectionData,localPathList3,remotePathList3, successList3); SCS_AfterPut(connectionData); 

bool SCS_AfterGet()

Description

Dreamweaver calls this function after getting or checking out one or more files. This function lets your DLL perform any operation after a batch get or check out, such as creating a summary dialog box.

Arguments

 *connectionData 

• The *connectionData argument is a pointer the agent's data that passed into Dreamweaver during the Connect() call.

Returns

A Boolean value: true if successful; false otherwise.

Example

See "bool SCS_BeforeGet()" on page 645.

bool SCS_AfterPut()

Description

Dreamweaver calls this function after putting or checking in one or more files. This function lets the DLL perform any operation after a batch put or check in, such as creating a summary dialog box.

Arguments

 *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.

Example

See "bool SCS_BeforePut()" on page 646.