diff options
Diffstat (limited to 'include/command_parse.h')
| -rw-r--r-- | include/command_parse.h | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/include/command_parse.h b/include/command_parse.h index 635db619c..40c3425fb 100644 --- a/include/command_parse.h +++ b/include/command_parse.h @@ -96,9 +96,13 @@ class CommandParser : public classbase * @param parameters Parameter list as an array of array of char (that's not a typo). * @param pcnt The number of items in the parameters list * @param user The user to call the handler on behalf of - * @return This method will return true if the command handler was found and called + * @return This method will return CMD_SUCCESS if the command handler was found and called, + * and the command completeld successfully. It will return CMD_FAILURE if the command handler was found + * and called, but the command did not complete successfully, and it will return CMD_INVALID if the + * command simply did not exist at all or the wrong number of parameters were given, or the user + * was not privilaged enough to execute the command. */ - bool CallHandler(const std::string &commandname,const char** parameters, int pcnt, userrec *user); + CmdResult CallHandler(const std::string &commandname,const char** parameters, int pcnt, userrec *user); /** This function returns true if a command is valid with the given number of parameters and user. * @param commandname The command name to check |