Oracle® Solaris Modular Debugger Guide

Exit Print View

Updated: September 2014
 
 

mdb_help_print_examples()

void mdb_help_print_examples(const char *title, const mdb_help_example_t *examples)

Prints examples of dcmds. examples is a NULL terminated array of mdb_help_example_t entries.

If the title is not NULL then it is printed as a title. If title is NULL then the title is automatically set to "EXAMPLES" if the examples array has more than one non NULL entry or "EXAMPLE" if there is just a single example. If title points to a zero length string no title is printed.

It then prints the examples array of {description, example} pairs in a uniform way on alternating lines with appropriate indentation and the description terminated with a ":". The mdb_help_example_t is defined thus:

typedef struct mdb_help_example {
            const char *mhe_desc;       /* Description */
            const char *mhe_example;    /* example "::walk walker | ::dcmd"*/
        } mdb_help_example_t;