User Guide

The Design Notes C API 57
The Design Notes C API
In addition to the JavaScript API, the MMNotes shared library also exposes a C API that lets
other applications create Design Notes files. It is not necessary to call these C functions directly if
you use the MMNotes shared library in Dreamweaver because the JavaScript versions of the
functions call them.
This section contains descriptions of the functions, their arguments, and their return values. You
can find definitions for the functions and data types in the MMInfo.h file in the Extending/
c_files folder inside the Dreamweaver application folder.
void CloseNotesFile()
Description
This function closes the specified Design Notes file and saves any changes. If all key/value pairs
are removed from the Design Note file, Dreamweaver deletes it. Dreamweaver deletes the _notes
folder when the last Design Notes file is deleted.
Arguments
FileHandle noteHandle
• The noteHandle argument is the file handle that the OpenNotesFile() function returns.
Returns
Nothing.
BOOL FilePathToLocalURL()
Description
This function converts the specified local drive path to a file:// URL.
Arguments
const
char* drivePath, char* localURLBuf, int localURLMaxLen
• The drivePath argument is a string that contains the full drive path.
• The localURLBuf argument is the buffer where the file:// URL is stored.
• The localURLMaxLen argument is the maximum size of localURLBuf.
Returns
A Boolean value: true indicates the operation is successful; false otherwise. The localURLBuf
argument receives the file:// URL value.
000_DW_API_Print.book Page 57 Wednesday, August 20, 2003 9:14 AM