wwHelp::Open

Opens a help project file. If the file does not exist this function prompts for a file unless the llSilent parameter is passed as true.

If no parameter is passed the help file is reselected or reopened as needed. The most efficient mechanism for getting the file is used.

wwHelp::Open(cFileName,llForceReopen,llSilent)

Return Value

.T. or .F.

Parameters

cFileName
The file name to open. Optional.
If no filename is passed the current help project file is used. If llForceReopen is not set to .T. if a help file is already open, it is selected rather than actually opening the file from disk.

llForceReopen
Forces the file to be reopened at all times, rather than using an already open copy. Use this when you need to open a new table. If this value is .F. the current alias is reselected if already open.

llSilent
Set to .T. if you don't want any prompts to display. By default a file open dialog will pop up if the file cannot be found.

Remarks

This method sets the cFileName property.

Check the cErrorMsg property for errors if this method returns .F.

Example

oHelp = CREATEOBJECT("wwHelp")
oHelp.Open("c:\temp\wchelp\wchelp.hbp")

Overloads:


See also:

Class wwHelp | wwHelp::cFileName | wwHelp::Close

© West Wind Techologies, 1996-2023 • Updated: 04/13/05
Comment or report problem with topic