Specifications
Chapter 24292
MMNotes.set()
Description
Creates or updates one key/value pair in a Design Notes file.
Arguments
fileHandle, keyName, valueString
• The first argument is the file handle that MMNotes.open() returns.
• The second argument is a string that contains the name of the key.
• The third argument is a string that contains the value.
Returns
A Boolean value that indicates whether the operation is successful.
Example
The following code opens the Design Notes file that is associated with a file in the dreamcentral
site called peakhike99/index.html, adds a new key/value pair, changes the value of an existing key,
and then closes the Note file.
var noteHandle = MMNotes.open(’file:///c|/sites/dreamcentral/
peakhike99/index.html’,true);
if(noteHandle > 0){
MMNotes.set(noteHandle,"Author","M. G. Miller");
MMNotes.set(noteHandle,"Last Changed","August 28, 1999");
MMNotes.close(noteHandle);
}
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.
Optional arguments are enclosed in braces ({ }).
void CloseNotesFile()
Description
Closes the specified Design Notes file and saves any changes. If all key/value pairs are removed
from the Note file, Dreamweaver deletes it. Deletes the _notes folder when the last Design Notes
file is deleted.
Arguments
FileHandle noteHandle
The argument is the file handle that OpenNotesFile() returns.
Returns
Nothing.