Adobe 38040334 - Dreamweaver CS3 User Manual page 101

int SCS_GetErrorMessageLength()
Description
This function returns the length of the DLL's current internal error message. This allocates the buffer that passes into
the
GetErrorMessage()
which indicates a failure of that API function.
Arguments
void *connectionData
• The
connectionData
call.
Connect()
Returns
An integer that represents the length of the error message.
bool SCS_GetErrorMessage()
Description
This function returns the last error message. If you implement
one of your API functions returns the value
If a routine returns or
-1 false
Arguments
void *connectionData, char errorMsg[], const int *msgLength
The argument is a pointer to the agent's data that passed into Dreamweaver during the
connectionData
call.
• The argument is a preallocated string for the DLL to fill in with the error message.
errorMsg
• The
argument is the length of the buffer represented by the
msgLength
Returns
A Boolean value: if successful;
true
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
call.
Connect()
• The argument is the remote file or folder path that the DLL checks for the number of attached Design
remotePath
Notes.
function. This function should be called only if an API function returns
argument is a pointer to the agent's data that passed into Dreamweaver during the
.
false
, it indicates an error message should be available.
otherwise.
false
argument is a pointer to the agent's data that passed into Dreamweaver during the
, Dreamweaver calls it each time
getErrorMessage()
errorMsg[]
DREAMWEAVER CS3
API Reference
or ,
false <0
Connect()
argument.
96