Deprecated Apple Help Functions

A function identified as deprecated has been superseded and may become unsupported in the future.

Deprecated in OS X v10.4

AHGotoMainTOC

Tells the Help Viewer to load the specified main table-of-contents page. (Deprecated in OS X v10.4. Use AHGotoPage to jump to different books or anchors.)

OSStatus AHGotoMainTOC (
   AHTOCType toctype
);
Parameters
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.

Return Value

A result code. See “Apple Help Result Codes.”

Discussion

This function is synchronous. Calling this function opens the Help Viewer application, if required, and loads the specified Help Center page.

Availability
  • Available in OS X v10.0 and later.
  • Deprecated in OS X v10.4.
Declared In
AppleHelp.h