Adobe 38040334 API Reference - Page 32

DREAMWEAVER CS3 27 API Reference • 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); } 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.