User Guide

56 Chapter 4: The Design Notes API
MMNotes.remove()
Description
The function removes the specified key (and its value) from the specified Design Notes file.
Arguments
fileHandle
, keyName
• The fileHandle argument is the file handle that the MMNotes.open() function returns.
• The keyName argument is a string that contains the name of the key to remove.
Returns
A Boolean value: true indicates the operation is successful; false otherwise.
MMNotes.set()
Description
This function creates or updates one key/value pair in a Design Notes file.
Arguments
fileHandle
, keyName, valueString
• The fileHandle argument is the file handle that the MMNotes.open() function returns.
• The keyName argument is a string that contains the name of the key.
• The valueString argument is a string that contains the value.
Returns
A Boolean value: true indicates the operation is successful; false otherwise.
Example
The following example 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 Design Notes 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);
}
000_DW_API_Print.book Page 56 Wednesday, August 20, 2003 9:14 AM