HelpPaths property

Microsoft Visio Developer Reference

HelpPaths property

       

Gets or sets the paths where Microsoft Visio looks for help files.

Version added

4.0

Syntax

strRet = object.HelpPaths
object.HelpPaths = pathsStr

strRet

String. A text string containing a list of folders where Visio looks for help files. Individual items are separated by semicolons.

object

Required. An expression that returns an Application object.

pathsStr

Required String. A text string containing a list of folders; to indicate more than one folder, separate individual items in the path string with semicolons.

Remarks

The string passed to and received from the HelpPaths property is the same string shown on the File Paths tab in the Options dialog box (click Options on the Tools menu). This string is stored in HKEY_CURRENT_USER\Software\Microsoft\Visio\application\HelpPath.

When the application looks for help files, it looks in all paths named in the HelpPaths property and all the subfolders of those paths. If you pass the HelpPaths property to the EnumDirectories method, it returns a complete list of fully qualified paths in which Visio looks.

If a path is not fully qualified, the application looks for the folder in the folder that contains the Visio program files (appObj.Path). For example, if the Visio executable file is installed in c:\Visio, and the HelpPaths property is "Help;d:\Help", the Visio application looks for help files in both c:\Visio\Help and d:\Help.