XMLParserItf Interface CATISAXInputSource
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISAXInputSource
Interface to represent a single input source for an XML entity.
This interface encapsulates information about an input source in a
single object, which may include a public identifier or a system
identifier
There are two places where the application will deliver this input
source to the parser: as the argument to the method, or as the return value of the
method.
A
encapsulates particular types of input sources. Implementations are provided for URL input sources, memory buffer input sources, and so on.
A
object belongs to the application: the parser never modifies them in any way. They are always passed by const reference so
the parser will make a copy of any input sources that it must keep
around beyond the call.
- See also:
- ,
Method Index
- o
GetEncoding(CATUnicodeString&)
- Retrieves the name of the encoding that is to be forced.
- o
GetPublicId(CATUnicodeString&)
- Retrieves the public identifier for this input source.
- o
GetSystemId(CATUnicodeString&)
- Retrieves the system identifier for this input source.
- o
SetEncoding(CATUnicodeString&)
- Sets the encoding which will be required for use with the XML text read
via a stream opened by this input source.
- o
SetPublicId(CATUnicodeString&)
- Sets the public identifier for this input source.
- o
SetSystemId(CATUnicodeString&)
- Sets the system identifier for this input source.
Methods
o GetEncoding
| public virtual GetEncoding( | | oEncoding) |
-
Retrieves the name of the encoding that is to be forced.
An input source can be set to force the parser to assume a particular
encoding for the data that input source reprsents, via the #href SetEncoding method.
If the encoding has never been forced, it returns an empty
.
- Parameters:
-
- oEncoding
- The forced encoding (can be an empty
if no forced encoding was given).
- See also:
-
o GetPublicId
| public virtual GetPublicId( | | oPublicId) |
-
Retrieves the public identifier for this input source.
- Parameters:
-
- oPublicId
- The public identifier (can be an empty
if no public identifier was given).
- See also:
-
o GetSystemId
| public virtual GetSystemId( | | oSystemId) |
-
Retrieves the system identifier for this input source.
If the system ID is a URL, it will be fully resolved.
- Parameters:
-
- oSystemId
- The system identifier.
- See also:
-
o SetEncoding
| public virtual SetEncoding( | const | iEncoding) |
-
Sets the encoding which will be required for use with the XML text read
via a stream opened by this input source.
This is usually not set, allowing the encoding to be sensed in the
usual XML way. However, in some cases, the encoding in the file is known
to be incorrect because of intermediate transcoding, for instance
encapsulation within a MIME document.
- Parameters:
-
- iEncoding
- The name of the encoding to force.
o SetPublicId
| public virtual SetPublicId( | const | iPublicId) |
-
Sets the public identifier for this input source.
The public identifier is always optional: if the application writer
includes one, it will be provided as part of the location information.
- Parameters:
-
- iPublicId
- The public identifier as a string.
- See also:
- , ,
o SetSystemId
| public virtual SetSystemId( | const | iSystemId) |
-
Sets the system identifier for this input source.
The system id is always required. The public id may be used to map
to another system id, but the system id must always be present as a fall
back.
If the system ID is a URL, it must be fully resolved.
- Parameters:
-
- iSystemId
- The system identifier as a string.
- See also:
- , ,
This object is included in the file: CATISAXInputSource.h
If needed, your Imakefile.mk should include the module: CatXmlItfBase
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.