Ets_Html_From_Ot_Generate()
Abstract
Generates an HTML web report from an output table (OT) file.
Syntax
Ets_Html_From_Ot_Generate (ot_file, style_sheet, output_page_path, buf_size, test_proc, test_state_ptr, options)
| Argument | Type | Description |
|---|---|---|
ot_file |
const char * |
OT file containing the tables to include in the HTML report. |
style_sheet |
const char * |
Style sheet to use for report, or NULL to use a default style sheet. |
output_page_path |
char * |
Buffer to hold the index of the created web report. |
buf_size |
int |
Size of output_page_path. |
test_proc |
EtsT_Html_Ot_Table_Test_Proc |
User-defined callback. If not NULL, this function is called to determine which tables to include in the report. |
test_state_ptr |
const void * |
User-defined data passed to test_proc when called (NULL if callback is not defined). |
options |
int |
Report options (bitwise OR of the values in Table 173 Utility Sub-Package Symbolic Constants; see Details). |
Return Type
PrgT_Compcode
PrgC_Compcode_Success if the web report is generated successfully; PrgC_Compcode_Failure otherwise.
Header
ets_api_html.h
Details
This function opens a dialog box to prompt the user to select:
- A table from
ot_fileto include in the report. - The destination directory for the report.
The user won’t be prompted for a table to include if test_proc is specified or if certain options are set. Commonly used options are:
ETSC_OT_HTML_OPT_NONE—No options.ETSC_OT_HTML_OPT_ALL_TABLES—Skip the table selection dialog box and include all tables from the OT file.ETSC_OT_HTML_OPT_NETWORK_DIAGRAM—Include a diagram of the network in the HTML report.ETSC_OT_HTML_OPT_EXCLUDE_OBJECT_TABLES—Exclude all object tables from the HTML report.