User Guide

130 Chapter 10: The Source Control Integration API
bool SCS_GetErrorMessage()
Description
This function returns the last error message. If you implement getErrorMessage(),
Dreamweaver calls it each time one of your API functions returns the value
false.
If a routine returns
-1 or false, it indicates an error message should be available.
Arguments
void *connectionData
, char errorMsg[], const int *msgLength
• The connectionData argument is a pointer to the agent’s data that passed into Dreamweaver
during the
Connect() call.
• The errorMsg argument is a preallocated string for the DLL to fill in with the error message.
• The msgLength argument is the length of the buffer represented by the errorMsg[]
argument.
Returns
A Boolean value: true if successful; false otherwise.
int SCS_GetNoteCount()
Description
This function returns the number of Design Note keys for the specified remote file or folder path.
If unsupported by the source control system, Dreamweaver gets this information from the
companion MNO file.
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
number of attached Design Notes.
Returns
An integer that indicates the number of Design Notes that are 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.
int SCS_GetMaxNoteLength()
Description
This function returns the length of the largest Design Note for the specified file or folder. If it is
unsupported by the source control system, Dreamweaver gets this information from the
companionMNO file.
000_DW_API_Print.book Page 130 Wednesday, August 20, 2003 9:14 AM