Ets_Html_Nt_Imagemap_Generate_Core()

Abstract

Generates an HTML page containing a diagram of a subnet, with options.

Syntax

Ets_Html_Nt_Imagemap_Generate_Core (nt_model_hndl, subnet_hndl, directory, main_page_name, options, image_names_tlptr, external_image_name, image_ptr, status_ptr)
Argument Type Description
nt_model_hndl EtsT_Model_Handle Model containing the subnet of interest. (If null or invalid, the current project is used.)
subnet_hndl EtsT_Obj_Handle Subnet of interest. (If null or invalid, the top subnet is used.)
directory const char * Directory in which to place the generated HTML page.
main_page_name const char * Name for the generated HTML page.
options int Options for generating the HTML page (see options).
image_names_tlptr VosT_Textlist * List (owned by caller) to be filled with the names of the image files generated, or PRGC_NIL if not wanted.
external_image_name char * Name used to link generated HTML to a previously captured image. Used only if the ETSC_HTML_NT_IMAGEMAP_OPT_USE_EXTERNAL_IMAGE option is set.
image_ptr void * Area to hold a copy of the image buffer that is generated. Used only if ETSC_NT_SUBNET_IMAGE_CAPTURE_OPT_IMAGE_BUFFER is set).
status_ptr EtsT_Compcode * Result of the operation, either EtsC_Compcode_Success or EtsC_Compcode_Failure.

Return Type

char *

PRGC_NIL, or the main HTML page (if the ETSC_HTML_NT_IMAGEMAP_OPT_GENERATE_BUFFER option is set)

ets_api_html.h

Details

This function creates HTML pages with imagemaps of the specified subnet and all child subnets, along with linked pages giving attribute information for each object. The imagemaps are saved in directory. You can change the default output in various ways by specifying different options.

options

options must be either ETSC_HTML_NT_IMAGEMAP_OPT_NONE or an OR’ed combination of one or more of the following constants:

  • ETSC_HTML_NT_IMAGEMAP_OPT_EXCLUDE_ATTRIBUTES—do not create pages with attribute data for each object
  • ETSC_HTML_NT_IMAGEMAP_OPT_SKIP_SIMPLE_SUBNETS—begin generating imagemaps with the first subnet (subnet_hndl or a child) that contains more than just a single subnet
  • ETSC_HTML_NT_IMAGEMAP_OPT_GRAPHICS_PNG—create graphics in PNG format (GIF is the default)
  • ETSC_HTML_NT_IMAGEMAP_OPT_GENERATE_BUFFER—return the HTML in a text buffer instead of a file
  • ETSC_HTML_NT_IMAGEMAP_OPT_NO_RECURSE—do not include child subnets
  • ETSC_HTML_NT_IMAGEMAP_OPT_GENERATE_OBJECT_LINKS—create the HTML with hyperlinks to the pages for each object
  • ETSC_HTML_NT_IMAGEMAP_OPT_NO_RESOLUTION_ADJUST—leave the subnet resolution as is (normally, this function will temporarily change the resolution of the subnet in order to capture the entire contents)
  • ETSC_HTML_NT_IMAGEMAP_OPT_USE_EXTERNAL_IMAGE—do not capture a graphic image; instead, link the HTML imagemap to a previously captured image specified by the external_image_name argument
  • ETSC_HTML_NT_IMAGEMAP_OPT_ONLY_IMAGE_TEXT—generate only the text for the imagemap instead of a complete page (this allows the text to be included on another page)
  • ETSC_HTML_NT_IMAGEMAP_OPT_NEW_BROWSER—generate hyperlinks that will open in a new browser window
  • ETSC_HTML_NT_IMAGEMAP_OPT_IS_TOP—create hyperlinks using object names that start with the subnet of interest (subnet_hndl) instead of full hierarchical names

本站文档由 北京智网畅联科技有限公司 整理、翻译并提供 · Documentation compiled and provided by Beijing ZNetLink Technology Co., Ltd.

交流群 · QQ Group:OPNET/智网妙算网络仿真交流群(群号 486383494)

原文档 © 2017 Riverbed Technology · 本站为公益翻译,由 AI 辅助完成,请仔细甄别

Original documentation © 2017 Riverbed Technology. Community translation, AI-assisted. Contact: jiazequn@znetlink.com