Adobe Dreamweaver API Reference CS5 - Manual (Page 32)

27 DREAMWEAVER API REFERENCE
The Design Notes API
Last updated 8/27/2013
Arguments
noteHandle
• The noteHandle argument is the file handle that the OpenNotesFile() function returns.
Returns
Nothing.
BOOL FilePathToLocalURL()
Description
This function converts the specified local drive path to a file:// URL.
Arguments
const char* drivePath, char* localURLBuf, int localURLMaxLen
• 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.
Returns
A Boolean value:
true indicates the operation is successful; false otherwise. The localURLBuf argument receives the
file:// URL value.
BOOL GetNote()
Description
This function gets the value of the specified key in the specified Design Notes file.
Arguments
FileHandle noteHandle, const char keyName[64], char* valueBuf, int valueBufLength
• 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.
Returns
A Boolean value:
true indicates the operation is successful; false otherwise. The valueBuf argument receives the
value of the key.
Example
The following code gets the value of the
comments key in the Design Notes file that is associated with the welcome.html file: