XMLParserItf Interface CATIXMLPPFactory
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIXMLPPFactory
Factory interface for objects of the XML writer API.
See and
objects.
Method Index
- o
CreateOutputSourceFromFile(CATUnicodeString&,CATIXMLPPOutputSource_var&)
- Creates a new CATIXMLPPOutputSource to write XML
in a file.
- o
CreateOutputSourceFromMemoryBuffer(CATXMLPPMemoryBuffer&,CATIXMLPPOutputSource_var&)
- Creates a new CATIXMLPPOutputSource to write XML
in a memory buffer.
- o
CreateXMLWriter(CATIXMLPPOutputSource_var&,CATIXMLPPWriter_var&,CATListOfCATUnicodeString&,CATListOfCATUnicodeString&)
- Creates a new CATIXMLPPWriter to write XML
in a memory buffer.
Methods
o CreateOutputSourceFromFile
public virtual CreateOutputSourceFromFile( | const | iXMLFilePath, |
| | oOutputSource) |
-
Creates a new CATIXMLPPOutputSource to write XML
in a file.
- Parameters:
-
- iXMLFilePath
- The absolute path of the XML write to generate
- oOutputSource
- The resulting CATIXMLPPOutputSource which will be used
to write in this XML file
o CreateOutputSourceFromMemoryBuffer
public virtual CreateOutputSourceFromMemoryBuffer( | const | iBuffer, |
| | oOutputSource) |
-
Creates a new CATIXMLPPOutputSource to write XML
in a memory buffer.
- Parameters:
-
- iBuffer
- A memory buffer object
- oOutputSource
- The resulting CATIXMLPPOutputSource which will be used
to write in this memory buffer
o CreateXMLWriter
public virtual CreateXMLWriter( | const | iOutputSource, |
| | oXMLWriter, |
| const | iOptions | = CATListOfCATUnicodeString(), |
| const | iOptionValues | = CATListOfCATUnicodeString()) |
-
Creates a new CATIXMLPPWriter to write XML
in a memory buffer.
- Parameters:
-
- iOutputSource
- An output source to store the generated XML
- oXMLWriter
- The resulting CATIXMLPPWriter which will be used
to write in this memory buffer
- iOptions
- The names of the options to set
- iOptionValues
- The values of the options to set.
The current list of options is
Option name |
Description |
Possible values |
Default value |
CATEncoding |
The value for the 'encoding' attribute of the XML header.
The recommended value is UTF-8. |
encoding value | UTF-8 |
CATSortAttributes |
Sorts the attributes of each elements alphabetically. |
true or false | false |
CATIndentation |
Controls how the output is formatted to produce human-readable indented XML. |
A positive or null integer specifying the number of
indentation characters to insert before each element |
0 (no identation) |
CATIndentationCharacter |
Specifies the indentation character to use when indentation is requested. |
A valid indentation character (space or tab) |
space |
This object is included in the file: CATIXMLPPFactory.h
If needed, your Imakefile.mk should include the module: CatXmlItfBase
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.