hwIWindow GetHTMLOutputType

Gets the window caption used when exporting to HTML.

Syntax

hwIWindow_handle GetHTMLOutputType

Application

Tcl Query

Description

Returns the HTML output type for the window. This is a string. It can be any of the following, depending on the client type of the window:
  • JPEG
  • AVI
  • h3d
  • Bitmap
  • HTML

This parameter is used during HTML export. It indicates the type of the object created when the user clicks on this window in the HTML report. Not all options are supported by every client.

Example

To determine the HTML output type of window 1 on page 1:
hwi GetSessionHandle mySessionName
mySessionName GetProjectHandle myProject 
myProject GetPageHandle myPage 1
myPage GetWindowHandle myWindow 1
myWindow GetHTMLOutputType

Error

If an error occurs, an empty string is returned.