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.
This function closes the specified Design Notes file and saves any changes. If all key/value pairs are removed from the Design Note file, Dreamweaver deletes it. Dreamweaver deletes the _notes folder when the last Design Notes file is deleted.
The drivePath argument is a string that contains the full drive path.
The localURLBuf argument is the buffer where the file:// URL is stored.
The localURLMaxLen argument is the maximum size of localURLBuf.
A Boolean value: true indicates the operation is successful; false otherwise. The localURLBuf argument receives the file:// URL 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 valueBuf argument is the buffer where the value is stored.
The valueBufLength argument is the integer that GetNoteLength(noteHandle, keyName) returns, which indicates the maximum length of the value buffer.
A Boolean value: true indicates the operation is successful; false otherwise. The valueBuf argument receives the value of the key.
The following code gets the value of the comments key in the Design Notes file that is associated with the welcome.html file:
FileHandle noteHandle = OpenNotesFile("file:///c|/sites/avocado8/iwjs/welcome.html");
if(noteHandle > 0){
int valueLength = GetNoteLength( noteHandle, "comments");
char* valueBuffer = new char[valueLength + 1];
GetNote(noteHandle, "comments", valueBuffer, valueLength + 1);
printf("Comments: %s",valueBuffer);
CloseNotesFile(noteHandle);
}
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.
See BOOL GetNote().
The noteHandle argument is the file handle that OpenNotesFile() returns.
The keyBufArray[64] argument is the buffer array where the keys are stored.
The keyArrayMaxLen argument is the integer that GetNotesKeyCount(noteHandle) returns, indicating the maximum number of items in the key buffer array.
A Boolean value: true indicates the operation is successful; false otherwise. The keyBufArray argument receives the key names.
The following code prints the key names and values of all the keys in the Design Notes file that are associated with the welcome.html file:
typedef char[64] InfoKey;
FileHandle noteHandle = OpenNotesFile("file:///c|/sites/avocado8/iwjs/welcome.html");
if (noteHandle > 0){
int keyCount = GetNotesKeyCount(noteHandle);
if (keyCount <= 0)
return;
InfoKey* keys = new InfoKey[keyCount];
BOOL succeeded = GetNotesKeys(noteHandle, keys, keyCount);
if (succeeded){
for (int i=0; i < keyCount; i++){
printf("Key is: %s\n", keys[i]);
printf("Value is: %s\n\n", GetNote(noteHandle, keys[i]);
}
}
delete []keys;
}
CloseNotesFile(noteHandle);
The filePath argument is the file://URL of the file for which you want the site root.
The siteRootBuf argument is the buffer where the site root is stored.
The siteRootBufMaxLen argument is the maximum size of the buffer that siteRootBuf references.
The infoPrefs argument, which is optional, is a reference to a struct in which the preferences for the site are stored.
A Boolean value: true indicates the operation is successful; false otherwise. The siteRootBuf argument receives the address of the buffer that stores the site root. If you specify the infoPrefs argument, the function also returns the Design Notes preferences for the site. The InfoPrefs struct has two variables: bUseDesignNotes and bUploadDesignNotes, both of type BOOL.
This function gets the version name of the MMNotes shared library, which indicates the application that implemented it.
The versionNameBuf argument is the buffer where the version name is stored.
The versionNameBufMaxLen argument is the maximum size of the buffer that the versionNameBuf argument references.
A Boolean value: true indicates the operation is successful; false otherwise. Dreamweaver stores "Dreamweaver" in versionNameBuf argument.
This function gets the version number of the MMNotes shared library, which lets you determine whether certain functions are available.
The versionNumBuf argument is the buffer where the version number is stored.
The versionNumBufMaxLen argument is the maximum size of the buffer that versionNumBuf references.
A Boolean value: true indicates the operation is successful; false otherwise. The versionNumBuf argument stores the version number.
The localURL argument, which is expressed as a file:// URL, is the path to a local file.
The drivePathBuf argument is the buffer where the local drive path is stored.
The drivePathMaxLen argument is the maximum size of the buffer that the drivePathBuf argument references.
A Boolean value: true indicates the operation is successful; false otherwise. The drivePathBuf argument receives the local drive path.
This function opens the Design Notes file that is associated with the specified file or creates one if none exists.
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 is turned off for the site or if the path specified by the localFileURL argument is not associated with any site.
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.
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.
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.
Twitter™ and Facebook posts are not covered under the terms of Creative Commons.