User Guide

The Source Control Integration API optional functions 131
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 the remote file or folder path that the DLL checks for the
maximum Design Note length.
Returns
An integer that indicates the size of the longest Design Note that is associated with this file. If the
function returns
< 0, Dreamweaver considers it an error and tries to retrieve the error message
from the DLL, if supported.
bool SCS_GetDesignNotes()
Description
This function retrieves key-value pairs from the meta information for the specified file or folder. If
it is unsupported by the source control system, Dreamweaver retrieves the information from the
companionMNO file.
Arguments
void *connectionData
, const char *remotePath, char keyList[][64],
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 correspond 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;
the GetNoteCount() call returns this value.
• The noteLength argument is the maximum length of a Design Note; this is the value that the
GetMaxNoteLength() call returns.
Returns
A Boolean value: true if successful; false otherwise.
bool SCS_SetDesignNotes()
Description
This function stores the key-value pairs in the meta information for the specified file or folder.
This replaces the set of meta information for the file. If it is unsupported by the source control
system, Dreamweaver stores Design Notes in MNO files.
000_DW_API_Print.book Page 131 Wednesday, August 20, 2003 9:14 AM