summaryrefslogtreecommitdiff
path: root/include/command_parse.h
diff options
context:
space:
mode:
authorbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2006-09-06 18:20:02 +0000
committerbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2006-09-06 18:20:02 +0000
commitecd5b4082a7ef4ae89116761c77285ed77b7a794 (patch)
tree60ad1013e3635ec4749559a7632ac6fd812507fe /include/command_parse.h
parent71ad308979d9c9129507fdf85d4305fd12e18bea (diff)
Finish off the fix for bug #136 (a biggie for such a simple thing)
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@5151 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'include/command_parse.h')
-rw-r--r--include/command_parse.h8
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