acedSetFunHelp

C++

int acedSetFunHelp(
    const ACHAR* pszFunctionName, 
    const ACHAR* pszHelpfile, 
    const ACHAR* pszTopic, 
    int iCmd
);

File

acedads.h

Description

Defines a Help call that should be made if a transparent Help request is made during a command line prompt for the function named pszFunctionName.

This function registers Help for functions that are called from the AutoCAD command line so that the appropriate Help file and topic are called when help is requested at a user prompt. acedSetFunHelp() may be used for ObjectARX commands, as well as ObjectARX and AutoLISP commands that start with C:.

To define a help call for an ObjectARX command that is registered with the AcEdCommandStack::addCommand() function, you must set pszFunctionName to the command's global name.

The remaining three parameters for acedSetFunHelp() are the same parameters as for acedHelp().

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

The acedSetFunHelp() function is typically called immediately after acedDefun(), using the same function name supplied to acedDefun(). The acedDefun() function clears any previously registered Help for the given command.

Note Help registered with acedSetFunHelp() cannot be used inside AutoLISP. It is used only with ObjectARX and AutoLISP functions that begin with C:.

The following example shows how to call acedSetFunHelp().

int funcload()
{
    char* exfun = "c:sld2ps";
    if (acedDefun(exfun, 0) != RTNORM)
        return 0;
    if (acedSetFunHelp(exfun, "sld2ps.chm" "sld2ps", 0) != RTNORM)
        return 0;
    return 1;
}

At this point, if the user requests transparent help at a command line prompt for sld2ps, then Help for the topic sld2ps from the file sld2ps.chm is displayed.

acedSetFunHelp() returns RTNORM if it is successful. If pszFunctionName does not start with C:, it returns RTERROR. No checking of the acedHelp() parameters (pszHelpfile, pszTopic, and iCmd) is done until the Help call is actually made.

Parameters