Specifications

Chapter 30360
• emailAddressList is a list of strings that corresponds to the users’ e-mail addresses. Each e-
mail address string cannot exceed a maximum length of 64 characters.
• numCheckedOut is the number of people who have the file checked out. This is returned from
GetNumCheckedOut().
Returns
true if successful; false otherwise.
int SCS_GetErrorMessageLength()
Description
Returns the length of the DLL’s current internal error message. This allocates the buffer that
passes into the
GetErrorMessage() function. This function should be called only if an API
function returns
false or <0, which indicates a failure of that API function.
Arguments
void *connectionData
connectionData
is a pointer to the agent’s data that was passed into Dreamweaver during the
Connect() call.
Returns
An integer that represents the length of the error message.
bool SCS_GetErrorMessage()
Description
Returns the last error message. If you implement getErrorMessage(), Dreamweaver calls it each
time one of your API functions returns
false.
If a routine returns -1 or false, it indicates an error message should be available.
Arguments
void *connectionData, char errorMsg[], const int *msgLength
• connectionData is a pointer to the agent’s data that passed into Dreamweaver during the
Connect() call.
• errorMsg is a preallocated string for the DLL to fill in with the error message.
• msgLength is the length of the errorMsg buffer passed in.
Returns
true if successful; false otherwise.
int SCS_GetNoteCount()
Description
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 Design Note (.mno) file.
Arguments
void *connectionData, const char *remotePath