User Guide

62 Chapter 4: The Design Notes API
FileHandle OpenNotesFilewithOpenFlags()
Description
This function 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 localFileURL argument, which is expressed as a file:// URL, is a string that contains 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 Design
Notes file even if Design Notes are turned off for the site or the path 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 bReadOnly argument, which is optional, is a Boolean value that indicates whether to open
the file in read-only mode. The default value is
false. You can specify the bReadOnly
argument starting in version 2 of the MMNotes.dll file.
BOOL RemoveNote()
Description
This function removes the specified key (and its value) from the specified Design Notes file.
Arguments
FileHandle noteHandle
, const char keyName[64]
• The noteHandle argument is the file handle that the OpenNotesFile() function returns.
• The keyName[64] 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.
BOOL SetNote()
Description
This function creates or updates one key/value pair in a Design Notes file.
Arguments
FileHandle noteHandle, const char keyName[64], const char* value
• The noteHandle argument is the file handle that the OpenNotesFile() function returns.
• The keyName[64] argument is a string that contains the name of the key.
• The value argument is a string that contains the value.
Returns
A Boolean value: true indicates the operation is successful; false otherwise.
000_DW_API_Print.book Page 62 Wednesday, August 20, 2003 9:14 AM