HCONSOLE

From RMX Automation Wiki

The HCONSOLE class is used to display text within the RMX Console window.

Contents 1 Usage 1.1 Globals 1.2 Enumerating consoles 1.3 Displaying text

[edit] Usage

[edit] Globals

CONSOLE_MAIN        //defines the primary console for RM-X

CONSOLE_ACTIVE      //additional consoles may grab the 'active' handle while processing data,
                    //this will display text on which ever has that handle

CONSOLE_BROADCAST   //used to display text on all consoles at once

[edit] Enumerating consoles

int total = 0;
vHCONSOLE console = vHCONSOLE::getFirst();
while (console) {
  total++;
  console = vHCONSOLE::getNext(console);
}

[edit] Displaying text

CONSOLE_MAIN->print("Hello World");
CONSOLE_MAIN->print("Plugin Name", "Status Message");
CONSOLE_MAIN->printWarning("Plugin Name", "Status Message");
CONSOLE_MAIN->printError("Plugin Name", "Status Message");