User Guide

48 The Design Notes API
int GetNotesKeyCount()
Description
This function gets the number of key/value pairs in the specified Design Notes file.
Arguments
FileHandle noteHandle
■ The noteHandle argument is the file handle that the OpenNotesFile() function returns.
Returns
An integer that represents the number of key/value pairs in the Design Notes file.
BOOL GetNotesKeys()
Description
This function gets a list of all the keys in a Design Notes file.
Arguments
FileHandle noteHandle, char* keyBufArray[64], int keyArrayMaxLen
■ 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.
Returns
A Boolean value: true indicates the operation is successful; false otherwise. The
keyBufArray argument receives the key names.
Example
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);
000_DW_API_Print.book Page 48 Wednesday, July 20, 2005 11:58 AM