User Guide

The Design Notes C API 61
BOOL GetVersionNum()
Description
This function gets the version number of the MMNotes shared library, which lets you determine
whether certain functions are available.
Arguments
char* versionNumBuf
, int versionNumBufMaxLen
• 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.
Returns
A Boolean value: true indicates the operation is successful; false otherwise. The
versionNumBuf argument stores the version number.
BOOL LocalURLToFilePath()
Description
This function converts the specified file:// URL to a local drive path.
Arguments
const char* localURL
, char* drivePathBuf, int drivePathMaxLen
• 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.
Returns
A Boolean value: true indicates the operation is successful; false otherwise. The drivePathBuf
argument receives the local drive path.
FileHandle OpenNotesFile()
Description
This function opens the Design Notes file that is associated with the specified file or creates one if
none exists.
Arguments
const char* localFileURL
, {BOOL bForceCreate}
• 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.
000_DW_API_Print.book Page 61 Wednesday, August 20, 2003 9:14 AM