Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagecpp
themeConfluence
FUNCTION xpxWriteXmlFileEx (repositoryName,

...

Argument:

...

Description:

...

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.

Arguments

...

TypeNameComment
STRINGrepositoryNameThe name of the data repository that contains the model to make a XML representation of. Repository names are case sensitive.
STRINGmodelName
Specifies the
The name of the data model from which data is to be
mapped
exported to the specified XML File. Model names are case sensitive.
GENERICdataItem
STRINGheaderRepositoryName
Specifies the
The name of the data repository that
hosts
contains the XML header model. Repository names are case sensitive.

When this <headerRepositoryName> = NULL the default value <headerRepositoryName> = <repositoryName> will be used.
If this parameter is NULL or an empty string, <headerRepositoryName> will be set equal to <repositoryName>
STRINGheaderModelNameSpecifies the name of the XML Header Model
in EDMdatabase
that will be
mapped
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
<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 (question), 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.

...

parameter <headerRepositoryName>.
STRINGxmlConfigurationNameThe name of the XML configuration. NULL means no configuration.
STRINGxmlFileNameThe name of the XML file to be generated.
STRINGdiagnosticFileSpecifies 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.
STRINGencodingEDM

The encoding of data in EDM (source). Default is UTF8. Legal values are;

  • "UTF-8"
  • "UTF-16"
  • "ISO-10646-UCS-2"
  • "ISO-10646-UCS-4"
  • "ISO-LATIN-1"
  • "ISO-LATIN-2"
  • "ISO-8859-3"
  • "ISO-8859-4"
  • "ISO-8859-5"
  • "ISO-8859-6"
  • "ISO-8859-7"
  • "ISO-8859-8"
  • "ISO-8859-9"
  • "ISO-2022-jp"
  • "SHIFT_JIS"
  • "EUC-JP"
STRINGencodingXMLThe encoding of data in XML (target). Default is UTF8. Legal values are the same as for encodingEDM.
INTEGERoptionsA bitwise OR between the options described below.
INTEGERnumberOfWarningsthe number of warnings generated by EDM when the model was exported.
INTEGERnumberOfErrorsthe number of errors encountered when the model was exported.
INTEGERsdaiErrorany EDMinterface error code returned from the EDMserver.

Return Value

...

Insert excerpt
US:_r_XPX_Return_Value
US:_r_XPX_Return_Value
nopaneltrue

Options

...

OptionComment

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

...

Code Block
languagecpp
<Missing Example>

 

See also

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
cqllabel = "extension_schema" and parent = "5636522"