Enumeration

PurpleCmdRet

since: 2.0

Declaration

enum Purple.CmdRet

Description [src]

Commands registered with the core return one of these values when run. Normally, a command will want to return one of the first two; in some unusual cases, you might want to have several functions called for a particular command; in this case, they should return

PURPLE_CMD_RET_CONTINUE to cause the core to fall through to other

commands with the same name.

Available since: 2.0

Members

Name Description
PURPLE_CMD_RET_OK

Everything’s okay; Don’t look for another command to call.

PURPLE_CMD_RET_FAILED

The command failed, but stop looking.

PURPLE_CMD_RET_CONTINUE

Continue, looking for other commands with the same name to call.