Specifications

The Design Notes API 297
FileHandle OpenNotesFile()
Description
Opens the Design Notes file that is associated with the specified file or creates one if none exists.
Arguments
const char* localFileURL, {BOOL bForceCreate}
• The first argument is a string that contains the path to the main file with which the Design
Notes file is associated, which is expressed as a file:// URL.
• The second argument is a Boolean value that indicates whether to create the Design Notes file
even if Design Notes is turned off for the site or if
localFileURL is not associated with any
site.
FileHandle OpenNotesFilewithOpenFlags()
Description
Opens the Design Notes file that is associated with the specified file or creates one if none exists.
You can open the file in read-only mode.
Arguments
const char* localFileURL, {BOOL bForceCreate}, {BOOL bReadOnly}
• The first argument is a string that contains the path to the main file with which the Design
Notes file is associated, which is expressed as a file:// URL.
• The second argument is a Boolean value that indicates whether to create the Design Notes file
even if Design Notes are turned off for the site or
filePath is not associated with any site. The
default value is
false. This argument is optional, but you need to specify it if you specify the
third argument.
• The third argument is a Boolean value that indicates whether to open the file in read-only
mode. The default value is
false. Optional. Available starting in version 2 of MMNotes.dll.
BOOL RemoveNote()
Description
Removes the specified key (and its value) from the specified Design Notes file.
Arguments
FileHandle noteHandle, const char keyName[64]
• The first argument is the file handle that OpenNotesFile() returns.
• The second argument is a string that contains the name of the key to remove.
Returns
A Boolean value that indicates whether the operation is successful.