Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HIOUtilityHTML Class Reference

#include <HIOUtilityHTML.h>

Public Member Functions

HFileOutputResult FileOutputByKey (const __wchar_t *filename, HC_KEY key, HOutputHandlerOptions *options)
 
HFileOutputResult FileOutputByKey (const unsigned short *filename, HC_KEY key, HOutputHandlerOptions *options)
 
HFileOutputResult FileOutputByKey (const char *filename, HC_KEY key, HOutputHandlerOptions *options)
 
const char * GetOutputName ()
 
HOutputHandlerStyle GetOutputStyle ()
 
const char * GetOutputTypesString ()
 
 HIOUtilityHTML ()
 
void RegisterOutputHandlerTypes ()
 

Detailed Description

The HIOUtilityHTML is used for exporting a HTML page which contains a control which references a HSF file of the same name. The handler creates both the HTML page and the HSF.

Note, the HTML page can only be viewed with Microsoft Internet Explorer.

Constructor & Destructor Documentation

HIOUtilityHTML::HIOUtilityHTML ( )
inline

Constructs an HIOUtilityHTML object.

References HOutputOpFileOutputByKey.

Member Function Documentation

HFileOutputResult HIOUtilityHTML::FileOutputByKey ( const __wchar_t *  filename,
HC_KEY  key,
HOutputHandlerOptions *  options 
)

This method creates an HTML page designed to work with a separatly created but identically named .hsf file. The HTML file embeds a HOOPS ActiveX control which loads the HSF into the HTML page.

Parameters
FileNameA character pointer denoting the name of the file to be written should usually include ".html".
keyThis parameter is current not used.
optionsPass options with specified width and height to determine the page dimensions.
Returns
The #HFileOutputResult result of the output operation.
const char* HIOUtilityHTML::GetOutputName ( )
inline
Returns
A character pointer denoting the name of the handler.
HOutputHandlerStyle HIOUtilityHTML::GetOutputStyle ( )
inline
Returns
The type of output style which is HOutputHandlerStyleHTML.

References HOutputHandlerStyleHTML.

const char* HIOUtilityHTML::GetOutputTypesString ( )
inline
Returns
The string of the type of output this handler creates which are "html" and "htm".
void HIOUtilityHTML::RegisterOutputHandlerTypes ( )
inline

This method registers the "html" and "htm" extensions to this handler as an output handler.

References HIORegisterOutputType.


The documentation for this class was generated from the following file: