edmiStepFileToHTML
- Former user (Deleted)
EdmiError edmiStepFileToHTML(SdaiString stepFile,
SdaiString htmlFile,
SdaiInteger options,
SdaiInteger htmlFileSize);
Produces an HTML representation of the specified STEP Physical File. The resulting HTML representation will be located in on one or more permanent files and can be displayed by any Internet browser. It is important to keep the HTML files relatively small to improve performance when displaying the HTML representation by an Internet browser, hence there exists several options to enable small sized HTML files.
Arguments
| Type | Name | Comment |
SdaiStringstepFile | Specifies the name of the STEP File to produce an HTML representation of. The default file extension is ".stp". | |
| SdaiString | htmlFile | Specifies the name of the HTML file produced by this command. The default file extension is ".html" on UNIX systems and ".htm" on Windows systems. When the SPLIT_HTML_FILE option is set, more than one file will be used to hold the HTML representation of the actual STEP file. The file name specified in this argument will be the main HTML file, i.e., the file name given to the Internet browser when invoking the browser. |
| SdaiInteger | options | Specifies the options to be used in the invocation of the edmiStepFileToHTML function. The <options> value can be specified as a bitwise OR between the actual options to enable. All option names are defined on the header file sdai.h . See detailed descriptions of the available options below. |
| SdaiInteger | htmlFileSize | Specifies the maximum size in bytes of each HTML file. This argument is only effective when the SPLIT_HTML_FILE option is set. A STEP file can be very large and normally the HTML representation of a STEP file will be much larger. To be able to browse a STEP file efficient in an Internet browser it is important to keep the HTML files relatively small, hence this argument should be used to define the maximum size of each of the HTML files and the SPLIT_HTML_FILE option should be set. |
Return Value
Options
| Option | Comment |
|---|---|
BOLD_STEP_ENTITY_NAMES | Specifies that the STEP entity names on the STEP file should be displayed in bold fonts. |
BOLD_STEP_ENTITY_REFERENCES | Specifies that all entity references will be displayed in bold fonts. Entity reference means a relation from one entity instance to another entity instance on the STEP file. |
BOLD_EXPRESS_ENTITY_NAMES | Specifies that all Express entity names will be displayed in bold fonts. |
INSTANCE_REFERENCES | Specifies that a list of all referencing instances will be produced for each entity instance on the STEP file. This list will be displayed in a separate frame in the browser. With this list it will be possible to browse both direction in a relation, i.e., from the referencing instance to the referenced instance and vice versa. |
HTML_FRAMES | Specifies that the STEP File will be displayed in a framed browser. |
SPLIT_HTML_FILE | Specifies that the HTML representation of the STEP file will be split in several files, each with a file size as specified in the <htmlFileSize> argument. |
Example
EdmiError rstat;
. . .
if (rstat = edmiStepFileToHTML(
"/usr/hkd/stp/bumper.stp",
"/usr/hkd/stp/bumbper.html",
BOLD_STEP_ENTITY_NAMES | BOLD_STEP_ENTITY_REFERENCES |
BOLD_EXPRESS_ENTITY_NAMES | INSTANCE_REFERENCES |
HTML_FRAMES | SPLIT_HTML_FILE,
0)) {
/* Error in operation */
printf("\nError: %s in edmiStepFileToHTML\n",
edmiGetErrorText(rstat));
goto error;
}
. . .
See also
Filter by label
There are no items with the selected labels at this time.