User Guide

44 The Design Notes API
Returns
A string that contains the local drive path for the specified file.
Example
A call to MMNotes.localURLToFilePath('file:///MacintoshHD/images/moon.gif')
returns "MacintoshHD:images:moon.gif".
MMNotes.open()
Description
This function opens the Design Notes file that is associated with the specified file or creates
one if none exists.
Arguments
filePath, {bForceCreate}
The filePath argument, which is expressed as a file:// URL, is the path to the main file
with which the Design Notes file is associated.
The bForceCreate argument is a Boolean value that indicates whether to create the note
even if Design Notes is turned off for the site or if the
filePath argument is not
associated with any site.
Returns
The file handle for the Design Notes file or 0 if the file was not opened or created.
Example
See “MMNotes.set()” on page 45.
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.
000_DW_API_Print.book Page 44 Wednesday, July 20, 2005 11:58 AM