All Frameworks Class Hierarchy This Framework Indexes Previous Next

XMLParserItf Interface CATIDOMCharacterData

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIDOMCharacterData

Interface extending CATIDOMNode with a set of methods for accessing character data in the DOM.
For clarity this set is defined here rather than on each class that uses these methods. No DOM objects correspond directly to , though and others do inherit the interface from it. All offsets in this interface start from 0, and index in terms of Unicode 16 bit storage units.

See also:

Method Index

o AppendData(CATUnicodeString&): Appends the string to the end of the character data of the node.
o DeleteData(unsigned int,unsigned int): Removes a range of characters from the node.
o GetData(CATUnicodeString&): Retrieves the character data of the node that implements this interface.
o GetLength(unsigned int&): Retrieves the number of characters that are available through data and the SubstringData method below.
o InsertData(unsigned int,CATUnicodeString&): Inserts a string at the specified character offset.
o ReplaceData(unsigned int,unsigned int,CATUnicodeString&): Replaces the characters starting at the specified character offset with the specified string.
o SetData(CATUnicodeString&): Sets the character data of the node that implements this interface.
o SubstringData(unsigned int,unsigned int,CATUnicodeString&): Extracts a range of data from the node.

Methods

o AppendData

public virtual AppendData( const iAppendedData)

Appends the string to the end of the character data of the node. Upon success, provides access to the concatenation of data and the specified.

Parameters:

iAppendedData: The

Errors Returned:

Error Class	Error Id	Description
	XMLParserERR_2207	NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

o DeleteData

public virtual DeleteData(		`iOffSet`,
		`iCount`)

Removes a range of characters from the node. Upon success, the returned values of and reflect the change.

Parameters:

iOffSet: The offset from which to remove characters.
iCount: The number of characters to delete. If the sum of iOffset and iCount exceeds the value returned by

Errors Returned:

Error Class	Error Id	Description
	XMLParserERR_2201	INDEX_SIZE_ERR: Raised if the specified `iOffset` is greater than the number of characters in `data`.
	XMLParserERR_2207	NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

o GetData

public virtual GetData( oData)

Retrieves the character data of the node that implements this interface. The DOM implementation may not put arbitrary limits on the amount of data that may be stored in a node. However, implementation limits may mean that the entirety of a node's data may not fit into a single call to GetData. In such cases, the user may call to retrieve the data in appropriately sized pieces.

Parameters:

oData: the character data of the node that implements this interface

Errors Returned:

Error Class	Error Id	Description
	XMLParserERR_2202	DOMSTRING_SIZE_ERR: Raised when it would return more characters than supported by the underlying implementation.

o GetLength

public virtual GetLength( oLength)

Retrieves the number of characters that are available through data and the SubstringData method below. This may have the value zero, i.e., CharacterData nodes may be empty.

Parameters:

oLength: The retrieved number of characters that are available through data.

See also:

o InsertData

public virtual InsertData(		`iOffSet`,
	const	`iInsertedData`)

Inserts a string at the specified character offset.

Parameters:

iOffSet: The character offset at which to insert.
iInsertedData: The

Errors Returned:

Error Class	Error Id	Description
	XMLParserERR_2201	INDEX_SIZE_ERR: Raised if the specified `iOffset` is greater than the number of characters in `data`.
	XMLParserERR_2207	NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

o ReplaceData

public virtual ReplaceData(		`iOffSet`,
		`iCount`,
	const	`iArg`)

Replaces the characters starting at the specified character offset with the specified string.

Parameters:

iOffSet: The offset from which to start replacing.
iCount: The number of characters to replace. If the sum of iOffSet and iCount exceeds the value returned by
iArg: The

Errors Returned:

Error Class	Error Id	Description
	XMLParserERR_2201	INDEX_SIZE_ERR: Raised if the specified `iOffset` is greater than the number of characters in `data`.
	XMLParserERR_2207	NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

o SetData

public virtual SetData( const iData)

Sets the character data of the node that implements this interface. The DOM implementation may not put arbitrary limits on the amount of data that may be stored in a node. However, implementation limits may mean that the entirety of a node's data may not fit into a single call to GetData. In such cases, the user may call to retrieve the data in appropriately sized pieces.

Parameters:

iData: The

Errors Returned:

Error Class	Error Id	Description
	XMLParserERR_2207	NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
	XMLParserERR_2202	DOMSTRING_SIZE_ERR: Raised when it would return more characters than supported by the underlying implementation.

o SubstringData

public virtual SubstringData(		`iOffSet`,
		`iCount`,
		`oSubstringData`)

Extracts a range of data from the node.

Parameters:

iOffset: Start offset of substring to extract.
iCount: The number of characters to extract.
oSubstringData: The specified substring. If the sum of iOffset and iCount exceeds the value returned by

Errors Returned:

Error Class	Error Id	Description
	XMLParserERR_2201	INDEX_SIZE_ERR: Raised if the specified `iOffset` is greater than the number of characters in `data`.
	XMLParserERR_2202	DOMSTRING_SIZE_ERR: Raised when it would return more characters than supported by the underlying implementation.

See also:

This object is included in the file: CATIDOMCharacterData.h
If needed, your Imakefile.mk should include the module: CatXmlItfExt