# nca_winhelp

Ancestor | nonvisualobject
Author | Ken Howe
Library | winhelp.pbl
Description | This object is a group of related functions for making calls to the winhelp API function.
Usage | Use this object to make calls to the winhelp API for popup help and access to the contents page.
Model |
nca_winhelp
Protected: integer HELP_CONTEXT = 1 integer HELP_CONTENTS = 3 integer HELP_CONTEXTPOPUP = 8 integer HELP_FINDER = 11
HelpContents (as_helpfile) reutrns integer HelpFinder (as_helpfile) reutrns integer HelpPopUp (al_topic, al_topic, al_topic) reutrns integer
Functions |
HelpContents
Description | This function will display the contents page for a help file.
Return | integer 1, help shown ok -1, show help failed
Access | public
Arguments |
Argument | DataType | Description
as_HelpFile | string | Path to the help file to use.
Usage | `lnca_WH.HelpContents( 'pbbrtray.hlp' )`
HelpFinder
Description | This function will open a help file and display the three tabbed dialog.
Return | integer 1, help shown ok -1, show help failed
Access | public
Arguments |
Argument | DataType | Description
as_HelpFile | string | Path to the help file to use
Usage | `lnca_WH.HelpFinder( 'pbbrtray.hlp' )`
HelpPopUp
Description | This function will display a help topic from a help file in a small popup window. This is used for showing context help for windows with those little question marks.
Return | integer 1, help shown ok -1, show help failed
Access | public
Arguments |
Argument | DataType | Description
aw_parent | window | Parent window to attach help to
as_HelpFile | string | Path to the help file to use
al_Topic | long | Topic number from the help file to display
Usage | `lnca_WH.HelpPopup( this, 'pbbrtray.hlp', 1 )`
Events | None
See Also | None

Document Generated: 7/24/99 12:08:02