User Guide

118 Chapter 10: The Source Control Integration API
The source control system can optionally support Design Notes and Check In/Check Out. The
Dreamweaver user enables Design Notes in source control systems by selecting the Design Notes
tab in the Edit Sites dialog box and checking the box that enables the feature; this process is same
to enable Design Notes with FTP and LAN. If the source control system does not support Design
Notes and the user wants to use this feature, Dreamweaver transports Design Note (MNO) files
to maintain the Design Notes (as it does with FTP and LAN).
Check In/Check Out is treated differently than the Design Notes feature; if the source control
system supports it, the user cannot override its use from the Design Notes dialog box. If the user
tries to override the source control system, an error message appears.
Adding source control system functionality
You can add source control system functionality to Dreamweaver by writing a GetNewFeatures
handler that returns a set of menu items and corresponding C functions. For example, if you
write a Sourcesafe library and want to let Dreamweaver users see the history of a file, you can
write a
GetNewFeatures handler that returns the History menu item and the C function name of
history. Then, in Windows, when the user right-clicks a file, the History menu item is one of
the items on the menu. If a user selects the History menu item, Dreamweaver calls the
corresponding function, passing the selected file(s) to the DLL. The DLL displays the History
dialog box so the user can interact with it in the same way as Sourcesafe.
The Source Control Integration API required functions
The Source Control Integration API has required and optional functions. The functions listed in
this section are required.
bool SCS_GetAgentInfo()
Description
This function asks the DLL to return its name and description, which appear in the Edit Sites
dialog box. The name appears in the Server Access pop-up menu (for example, sourcesafe,
webdav, perforce) and the description below the pop-up menu.
Arguments
char name[32], char version[32], char description[256], const char *dwAppVersion
• The name argument is the name of the source control system. The name appears in the combo
box for selecting a source control system on the Source Control tab in the Edit Sites dialog box.
The name can be a maximum of 32 characters.
• The version argument is a string that indicates the version of the DLL. The version appears
on the Source Control tab in the Edit Sites dialog box. The version can be a maximum of
32 characters.
• The description argument is a string that indicates the description of the source control
system. The description appears on the Source Control tab in the Edit Sites dialog box. The
description can be a maximum of 256 characters.
• The dwAppVersion argument is a string that indicates the version of Dreamweaver that is
calling the DLL. The DLL can use this string to determine the version and language
of Dreamweaver.
000_DW_API_Print.book Page 118 Wednesday, August 20, 2003 9:14 AM