User Guide

132 Chapter 10: The Source Control Integration API
Arguments
void *connectionData, const char *remotePath, const char keyList[][64],
const char *valueList[], bool showColumnList[], const int noteCount,
const int noteLength
• The connectionData argument is a pointer to the agent’s data that passed into Dreamweaver
during the
Connect() call.
• The remotePath argument is the remote file or folder path that the DLL checks for the
number of items.
• The keyList argument is a list of Design Note keys, such as "Status".
• The valueList argument is a list of Design Note values that corresponds to the Design Note
keys, such as
"Awaiting Signoff".
• The showColumnList argument is a list of Boolean values that correspond to the Design Note
keys, which indicate whether Dreamweaver can display the key as a column in the Site panel.
• The noteCount argument is the number of Design Notes that are attached to a file or folder;
this number lets the DLL know the size of the specified lists. If
noteCount is 0, all the Design
Notes are removed from the file.
• The noteLength argument is the length of the largest Design note for the specified file
or folder.
Returns
A Boolean value: true if successful; false otherwise.
bool SCS_IsRemoteNewer()
Description
This function checks each specified remote path to see if the remote copy is newer.
If it is unsupported by the source control system, Dreamweaver uses its internal
isRemoteNewer algorithm.
Arguments
void *connectionData
, const char *remotePathList[], const char *localPathList[],
int remoteIsNewerList[], 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 compare for
newer status.
• The localPathList argument is a mirrored list of local filenames or folder paths.
• The remoteIsNewerList argument is a list of integers that are populated by the DLL to let
Dreamweaver know which of the corresponding files is newer on the remote side. The
following values are valid: 1 indicates the remote version is newer; -1 indicates the local version
is newer; 0 indicates the versions are the same.
• The numItems argument is the number of items in each list.
Returns
A Boolean value: true if successful; false otherwise.
000_DW_API_Print.book Page 132 Wednesday, August 20, 2003 9:14 AM