Register a HELP handler that prints usage documentation.
Synopsis
Declared in <balb_controlmanager.h>
int
registerUsageHandler(std::ostream& stream);Description
Register a handler that, on receipt of a (case‐insensitive) "HELP" message, prints to the specified stream a list of this `ControlManager`s registered commands and their documentation. Return a positive value if an existing callback was replaced, return 0 if no replacement occurred, and return a negative value otherwise.
Return Value
positive if replaced, 0 if new, negative otherwise
Parameters
Name |
Description |
stream |
output stream to which usage is printed |
Created with MrDocs