xpxWriteXmlFileEx

FUNCTION xpxWriteXmlFileEx (repositoryName, modelName                : STRING;
                            dataItem                                 : GENERIC;
                            headerRepositoryName, headerModelName    : STRING;
                            xmlConfigurationName, xmlFileName        : STRING;
                            diagnosticFile, encodingEDM, encodingXML : STRING;
                            options                                  : INTEGER;
                            VAR warnings, VAR errors, VAR sdaiError  : INTEGER)
                            status                                   : INTEGER;

Export an edmModel or parts of an edmModel to an Xml-formatted file on the file system. This function has an insufficient parameter list. Use the improved xpxWriteXMLFileEx instead. xpxWriteXMLFile has been kept for compatibility reasons.

Arguments

STRING

Type	Name	Comment
STRING	repositoryName	The name of the data repository that contains the model to make a XML representation of. Repository names are case sensitive.
STRING	modelName	The name of the data model from which data is to be exported to the specified XML File. Model names are case sensitive.
GENERIC	dataItem
STRING	headerRepositoryName	The name of the data repository that contains the XML header model. Repository names are case sensitive. If this parameter is NULL or an empty string, <headerRepositoryName> will be set equal to <repositoryName>
STRING	headerModelName	Specifies the name of the XML Header Model that will be exported to the Header Section in the resulting XML file. XML Header Model names are case sensitive. The specified XML Header Model must be located in the repository specified by the parameter <headerRepositoryName>.
STRING	xmlConfigurationName	The name of the XML configuration. NULL means no configuration.
STRING	xmlFileName	The name of the XML file to be generated.
STRING	diagnosticFile	Specifies the file name for diagnostic information generated by this function. If no file name is supplied, i.e. the <diagnosticFileName> argument is set to NULL or an empty string, all diagnostic information will be written to the EDMinterface current output device.
STRING

INTEGER	options	A bitwise OR between the options described below.
INTEGER	numberOfWarnings	the number of warnings generated by EDM when the model was exported.
INTEGER	numberOfErrors	the number of errors encountered when the model was exported.
INTEGER	sdaiError	any EDMinterface error code returned from the EDMserver.

Return Value

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'US:_r_XPX_Return_Value'.

Options

Option	Comment
INCLUDE_HEADER	Include header element when writing ISO_10303_28 document
INCLUDE_CONFIGURATION	Include configuration element when writing ISO_10303_28 document
INCLUDE_SCHEMA	Include schema elements when writing ISO_10303_28 document
EXTRACT_SHALLOW	Use this option to prevent referenced instances to be exported. By default EDM will export all the instances given in data and the entire mesh of referenced instances that spreads out from them.
EDM_IDENTIFIERS	Use the full internal instanceIds of EDM as step Ids in the exported XML file. By default, the step Ids are the local references from within each model.

Example

<Missing Example>

SYNTAX:

xpxWriteXmlFileEx (repositoryName, modelName : STRING; dataItem : GENERIC; headerRepositoryName, headerModelName : STRING; xmlConfigurationName, xmlFileName : STRING; diagnosticFile, encodingEDM, encodingXML : STRING; options : INTEGER; VAR warnings, VAR errors, VAR sdaiError : INTEGER) status : INTEGER;

To be completed.
The xpxWriteXmlFileEx function can be used to produce a XML File (Part 28 file)
The arguments in the xpxWriteXmlFileEx have the following meaning:

Argument:	Description:
repositoryName	Specifies the name of the data repository that holds the model to make a XML representation of. Repository names are case sensitive.
modelName	Specifies the name of the data model to be mapped to the specified XML File. Model names are case sensitive.
headerRepositoryName	Specifies the name of the data repository that hosts the XML header model. Repository names are case sensitive. When this <headerRepositoryName> = NULL the default value <headerRepositoryName> = <repositoryName> will be used.
headerModelName	Specifies the name of the XML Header Model in EDMdatabase^ that will be mapped to the Header Section in the resulting XML file. XML Header Model names are case sensitive. The specified XML Header Model must be located in the repository specified by the <repositoryName> argument. All instances in the specified <headerModelName> will be mapped to the XML file Header Section as is, except that the attribute FILE_DESCRIPTION.IMPLEMENTATION_LEVEL is set according to the mapping method specified by one of the following options: CONFORMANCE_CLASS_1, CONFORMANCE_CLASS_2 or EDM_PRIVATE_FORMAT. The attribute FILE_NAME.TIME_STAMP is set to the current date and time, i.e., the date and time when the XML file is produced. When the NO_HEADER_CHANGE option is set, the specified header model will be mapped as is, i.e., also the three attribute values described above will be mapped from the specified header model to the XML file. When the <headerModelName> argument is blank, a default Header Section is produced. This default header section can be configured by setting the EDM system variable EDM_XML_FILE_AUTHOR.
xmlConfigurationName
xmlFileName	Specifies the name of the file that will hold the resulting XML file. Default file extension is ?.xml?.
diagnosticFile	Diagnostic file. The xpxWriteXmlFileEx function will record all diagnostics found during writing of the XML file. When the <diagnosticFile> argument is set to an empty string or to indeterminate , then no diagnostic recording will be produced.
encodingEDM
encodingXML
options	The options are equivalent to the options used in the EDMinterface^ function edmiWriteXmlFileEx.
warnings	This argument will receive the number of warnings detected during the xpxWriteXmlFileEx operation.
errors	This argument will receive the number of errors detected during the xpxWriteXmlFileEx operation.
sdaiError	If the xpxWriteXmlFileEx operation is terminated due to errors in accessing the database, the argument <sdaiError> will receive the actual sdaiErrorCode causing the termination of the xpxWriteXmlFileEx operation.

This function is equivalent to the EDMinterface^ function edmiWriteXmlFileEx.

Arguments

Return Value

Options

Example

See also

Filter by label