edmiRemoteStepFileToHTML
EdmiError edmiRemoteStepFileToHTML(SdaiServerContext serverContextId, SdaiString stepFile, SdaiString htmlFile, SdaiInteger options, SdaiInteger htmlFileSize, SdaiInvocationId *edmiInvocationId);
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 web browser. It is important to keep the HTML files relatively small to improve performance when displaying the HTML representation.
Arguments
Type | Name | Comment |
SdaiServerContext | serverContextId | Context identification, from edmiDefineServerContext |
SdaiString | stepFile | The name of the STEP Physical File to produce an HTML representation of. The default file extension is ".stp". |
SdaiString | htmlFile | The name of the HTML file produced by this command. The default file extension for UNIX is ".html". For Windows systems it is ".htm". When the SPLIT_HTML_FILE option is set, more than one file will be used to hold the HTML representation of the actual STEP Physical 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 | See list of available options below. Options may be combined by the bitwise OR operator. |
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. STEP Physical files may be huge. HTML representations of STEP Physical file will be even greater. To enable efficient browsing of HTML files in an Internet browser it is important to keep the files relatively small. This argument may be used to specify the maximum allowable size of the generated HTML files. |
SdaiInvocationId | edmiInvocationId | Currently not used. |
Return Value
Options
Option | Comment |
SPLIT_HTML_FILE | If necessary, the HTML representation of the STEP Physical file will be split in multiple files, each with a maximum file size specified by the <htmlFileSize> argument. |
BOLD_EXPRESS_ENTITY_NAMES | Express entity names will be displayed in bold text. |
BOLD_STEP_ENTITY_REFERENCES | Entity references will be displayed in bold text. An Entity reference is a relation from one entity instance to another entity instance within the STEP Physical file. |
BOLD_STEP_ENTITY_NAMES | Specifies that the STEP entity names on the STEP Physical file should be displayed in bold text. |
INSTANCE_REFERENCES | Specifies that a list of all referencing instances will be produced for each entity instance on the STEP Physical file. This list will be displayed in a separate frame in the browser. With this list it will be possible to browse both directions of a relation, i.e., from the referencing instance to the referenced instance and vice versa. |
HTML_FRAMES | Specifies that the STEP Physical File will be displayed in a framed browser. |
Example
EdmiError rstat, error; SdaiInteger nWrn, nErr; SdaiServerContext myContext; /* Create Server Context */ rstat = edmiDefineServerContext("MyContext", "Johnny", "Supervisor", "cf37ftr", "TCP", "9090", "MyServerHost", NULL, NULL, NULL, NULL, NULL, &myContext); /* Read the population into the remote database */ rstat = edmiRemoteReadStepFile(myContext, "OurRemoteRepository", "OurRemoteModel", NULL, NULL, "c:/data/population.stp", "c:/temp/population.dia", "OurExpressSchema", NULL, DELETING_EXISTING_MODEL | LOG_TO_FILE, &nWrn, &nErr, &error, NULL); . . . /* Modify the population remotely */ . . . /* Write the modified population back on a step physical file */ rstat = edmiRemoteWriteStepFile(myContext, "OurRemoteRepository", "OurRemoteModel", NULL, NULL, "c:/data/new_population.stp", "c:/temp/new_population.dia", NULL, KEEP_STEP_IDENTIFIERS, 6, &nWrn, &nErr, &error, NULL); /* Generate HTML representation */ rstat = edmiRemoteStepFileToHTML(myContext, "c:/data/new_population.stp", "c:/data/html/new_population.html", SPLIT_HTML_FILE | BOLD_EXPRESS_ENTITY_NAMES, 1048576, NULL); . . .
See also
Filter by label
There are no items with the selected labels at this time.