User Guide

60 Chapter 4: The Design Notes API
BOOL GetSiteRootForFile()
Description
This function determines the site root for the specified Design Notes file.
Arguments
const char* filePath
, char* siteRootBuf, int siteRootBufMaxLen,
{InfoPrefs* infoPrefs}
• The filePath argument is the file://URL of the file for which you want the site root.
• The siteRootBuf argument is the buffer where the site root is stored.
• The siteRootBufMaxLen argument is the maximum size of the buffer that
siteRootBuf references.
• The infoPrefs argument, which is optional, is a reference to a struct in which the
preferences for the site are stored.
Returns
A Boolean value: true indicates the operation is successful; false otherwise. The siteRootBuf
argument receives the address of the buffer that stores the site root. If you specify the
infoPrefs
argument, the function also returns the Design Notes preferences for the site. The
InfoPrefs
struct has two variables:
bUseDesignNotes and bUploadDesignNotes, both of type BOOL.
BOOL GetVersionName()
Description
This function gets the version name of the MMNotes shared library, which indicates the
application that implemented it.
Arguments
char* versionNameBuf
, int versionNameBufMaxLen
• The versionNameBuf argument is the buffer where the version name is stored.
• The versionNameBufMaxLen argument is the maximum size of the buffer that the
versionNameBuf argument references.
Returns
A Boolean value: true indicates the operation is successful; false otherwise. Dreamweaver stores
"Dreamweaver" in versionNameBuf argument.
000_DW_API_Print.book Page 60 Wednesday, August 20, 2003 9:14 AM