  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Nine — Dialog Functions (continued)
Overview
The DialogSetHelp function sets the base help file or reference for a dialog. This can be later referenced if the user selects the help button, presses F1, or chooses a context help item.
Syntax/Parameters
Syntax
int = DialogSetHelp ( string url );
Parameters
url
A string representing the location of the help data. For a web reference, it must be a fully qualified HTTP address. For Compiled HTML Help (CHM), it can be a full path and internal reference or a local reference.
Return Value
Returns an int value as ERROR_NONE or a formatted error code. Use the GetLastError function to retrieve error information.
Remarks
For CHM files, if a path is not specified, the file is expected to be located in the “Help” folder of the application. CHM files expect the trailing file reference to be appended in the form:
filename ::/ item
Where:
filename
The CHM file with or without the path. If a path is omitted or does not form a root position, the file is assumed to be located in the application’s “Help” folder or subfolder.
::/
The delimiter (all internal help component files start at the root, hence ‘/’).
item
The filename and optional name reference for the internal help file.
Note that the help action can also be intercepted by the dialog’s dialog_help procedure allowing for additional processing.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
Page revised 2024-10-21
| Table of Contents | < < Previous | Next >> |
© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.