User Guide

The Source Control Integration API required functions 119
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.
Returns
A Boolean value: true if successful; false otherwise.
000_DW_API_Print.book Page 119 Wednesday, July 20, 2005 11:58 AM