| Mac OS X header: | Carbon/Carbon.h |
| Mac OS 9 header: | AppleHelp.h |
| Navigation Functions Functions | |
| AHGotoMainTOC | Tells the Help Viewer to load the specified main table-of-contents page. |
| AHGotoPage | Tells the Help Viewer to load the specified HTML page. |
| AHLookupAnchor | Tells the Help Viewer to search for a specified anchor and load it. |
AHGotoMainTOC |
| Carbon status: | Supported |
Tells the Help Viewer to load the specified main table-of-contents page.
OSStatus AHGotoMainTOC (
AHTOCType toctype
);
A value specifying which Help Center page should be loaded. If you pass the kAHTOCTypeUser constant, for example, the Help Viewer loads the Help Center page.
A result code.
This function is synchronous. Calling this function opens the Help Viewer application, if required, and loads the specified Help Center page.
Supported in Carbon. Available in Carbon 1.1 and later when running Mac OS 8.6 or later.
AHGotoPage |
| Carbon status: | Supported |
Tells the Help Viewer to load the specified HTML page.
OSStatus AHGotoPage (
CFStringRef bookname,
CFStringRef path,
CFStringRef anchor
);
A string specifying the name of the help book that contains the page to be loaded. If the name of the help book (as specified by the AppleTitle meta tag) is SurfWriter Help, for example, you pass a string containing the value SurfWriter Help. You may pass NULL in this parameter.
A string specifying a path for the page to be loaded. Specify the path relative to the help book given in the bookname parameter. If you pass NULL in this parameter, the Help Viewer opens to your help book’s title page. If you pass NULL in the bookname parameter, you must specify the value passed in the path parameter as a full URL in the form file://.
An optional string specifying an anchor to which the Help Viewer scrolls after loading the specified page. If you do not specify an anchor, the Help Viewer scrolls to the top of the page.
A result code.
This function is synchronous. Calling this function opens the Help Viewer application, if required, and loads the specified HTML page.
Supported in Carbon. Available in Carbon 1.1 and later when running Mac OS 8.6 or later.
AHLookupAnchor |
| Carbon status: | Supported |
Tells the Help Viewer to search for a specified anchor and load it.
OSStatus AHLookupAnchor (
CFStringRef bookname,
CFStringRef anchor
);
A string specifying the name of the help book to search for the desired anchor. If the name of the help book (as specified by the AppleTitle meta tag) is SurfWriter Help, for example, you pass a string containing the value SurfWriter Help. If you do not specify a value in this parameter, the Help Viewer searches all available help books for the specified anchor.
A string specifying an anchor to load. You should ensure that each anchor name in your help book is unique. If you specify an anchor name that is not unique, the Help Viewer displays a list of links to all the anchors with that name.
A result code.
This function is synchronous. Calling this function opens the Help Viewer application, if required, and loads the specified anchor or the list of links to multiple anchors, as appropriate. You must specify anchor indexing when you index your help book to perform anchor lookup.
Supported in Carbon. Available in Carbon 1.1 and later when running Mac OS 8.6 or later.
© 2001 Apple Computer, Inc. (Last Updated July 17, 2001)