acedHelp

C++

int acedHelp(
    const ACHAR* szFilename, 
    const ACHAR* szTopic, 
    int iCmd
);

File

acedads.h

Description

Provides Help using the specified HTML Help file.

If szFilename is NULL, acedHelp() tries the name in the ACADHELP environment variable. If no ACADHELP environment variable exists, then it tries the product-specific built-in name (for example, acad.chm or acad.hlp for AutoCAD).

Note Use acedHelp() to make a call for Help from a dialog box button. Use acedSetFunHelp() to define a call for command line help.

If szFilename is an HTML Help file and command is not equal to 0, the three acedHelp() parameters are passed directly to HtmlHelp() in the Microsoft Windows API. The topic parameter is cast to the DWORD dwdata parameter of HtmlHelp(). See the Microsoft Windows SDK documentation for a complete description of HtmlHelp().

The acedHelp() function returns RTNORM if it is successful. It returns RTERROR if the Help file is not found. Your application does not have to generate error messages because HTML Help reports errors directly to the user.

The following samples show various Help calls:

/* Bring up Help for the TRIM command in AutoCAD
Help (by default acad.chm) */
acedHelp(NULL, "trim", 0); 

/* Bring up Help for the topic my_dialog in the file
myfile.chm. */
acedHelp("myfile.chm", "my_dialog", 0);

Parameters