Provides non-cached forward-only access to XML data. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

Inherits System::IDisposable.

Inherited by System::Xml::XmlTextReader.

Public Types
typedef SharedPtr< XmlReader >	Ptr
	An alias for shared pointer to an instance of this class. More...

Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

Public Member Functions
virtual String	get_Name ()
	Returns the qualified name of the current node. More...

virtual String	get_Prefix ()
	Returns the prefix of the current node. More...

virtual String	get_LocalName ()
	Returns the local name of the current node. More...

virtual String	get_NamespaceURI ()
	Returns the namespace URI of the current node. More...

virtual String	get_BaseURI ()
	Returns the base URI of the current node. More...

virtual String	get_Value ()=0
	Returns the value of the current node. More...

virtual SharedPtr< Schema::IXmlSchemaInfo >	get_SchemaInfo ()

String	idx_get (const String &name)
	Returns the value of the attribute with the specified name. More...

virtual ReadState	get_ReadState ()
	Returns the current state of the reader. More...

virtual bool	get_IsEmptyElement ()=0
	Determines if the current node is an empty element. More...

virtual bool	get_IsDefault ()
	Determines if the current node is an attribute that was generated from the default value defined in the DTD or schema. More...

virtual int	get_Depth ()
	Returns the depths of the current node in the XML tree. More...

virtual bool	get_EOF ()
	Determines if the reader has reached the end of stream. More...

virtual bool	get_HasAttributes ()
	Determines if the current node has any attributes. More...

virtual int	get_AttributeCount ()=0
	Returns the number of attributes in the current node. More...

virtual bool	get_HasValue ()
	Determines if the current node has a value. More...

virtual String	get_XmlLang ()
	Returns the current xml:lang scope. More...

virtual UChar	get_QuoteChar ()
	Returns the used as quotation mark character used to enclose the value of an XML attribute node. More...

virtual XmlNodeType	get_NodeType ()=0
	Returns the type of the current node. More...

virtual bool	get_CanResolveEntity ()
	Determines whether the current XmlReader object can parse and resolve entities. More...

virtual String	GetAttribute (int32_t index)
	Returns the value of the attribute with the specified index. More...

virtual String	GetAttribute (const String &name)
	Returns the value of the attribute with the specified name. More...

virtual bool	MoveToAttribute (const String &name)
	Moves the reader's position to the attribute with the specified name. More...

virtual String	GetAttribute (const String &localName, const String &namespaceURI)
	Gets the value of the attribute with the specified local name and namespace URI. More...

virtual void	MoveToAttribute (int index)
	Moves the reader's position to the attribute with the specified index. More...

virtual bool	MoveToNextAttribute ()
	Moves the reader's position to the next attribute. More...

virtual bool	MoveToFirstAttribute ()
	Moves the reader's position to the first attribute in the list of attributes of the current node. More...

virtual bool	ReadToNextSibling (const String &name)
	Moves the position of the reader to the next sibling with the specified name. More...

virtual Ptr	ReadSubtree ()
	Read an element and all its children, and return a new XmlReader object set to ReadState::Initial. More...

virtual XmlNodeType	MoveToContent ()=0
	Moves the position of the reader to the next content node, skipping the non-content nodes. More...

virtual bool	MoveToElement ()=0
	Moves the reader's position to the element node that contains the current attribute node. More...

virtual bool	Next ()
	Navigates to the next token. More...

virtual bool	Read ()=0
	Reads the next node. More...

virtual String	LookupNamespace (const String &prefix)=0
	Resolves a namespace prefix in the scope of the current element. More...

virtual void	Skip ()=0
	Skips the children of the current node. More...

virtual void	Close ()=0
	Changes the state of the reader to ReadState::Closed. More...

virtual String	ReadString ()=0
	Reads the contents of an element or a text node. More...

virtual void	ReadStartElement ()=0
	Checks if the current content node is an element and moves the the reader's position to the next node. More...

virtual void	ReadStartElement (const String &value)=0
	Checks if the current content node is an element with the specified qualified name and moves the the reader's position to the next node. More...

virtual void	ReadStartElement (const String &localName, const String &namespaceUri)=0
	Checks if the current content node is an element with the specified local name and namespace URI and moves the the reader's position to the next node. More...

virtual String	ReadInnerXml ()=0
	Returns a string containing all the content of the current node, including the markup, but excluding start and end tags. More...

virtual String	ReadOuterXml ()=0
	Returns a string containing all the content of the current node, including the markup, and including start and end tags. More...

virtual bool	ReadToFollowing (const String &name)
	Reads until an element with the specified name is encountered. More...

virtual bool	ReadToFollowing (const String &localName, const String &namespaceURI)
	Reads until an element with the specified local name name and namespace URI is encountered. More...

virtual bool	ReadToDescendant (const String &name)
	Reads to the first descendant of the current element with the given name. More...

virtual bool	ReadToDescendant (const String &localName, const String &namespaceURI)

virtual SharedPtr< System::Xml::XmlNameTable >	get_NameTable ()
	Gets name table associated with document being read. More...

virtual bool	ReadContentAsBoolean ()
	Reads current element's contents as boolean. More...

virtual double	ReadContentAsDouble ()
	Reads current element's contents as double. More...

virtual float	ReadContentAsFloat ()
	Reads current element's contents as float. More...

virtual Decimal	ReadContentAsDecimal ()
	Reads current element's contents as decimal. More...

virtual int32_t	ReadContentAsInt ()
	Reads current element's contents as integer. More...

virtual int64_t	ReadContentAsLong ()
	Reads current element's contents as long integer. More...

virtual String	ReadContentAsString ()
	Reads current element's contents as string. More...

virtual bool	ReadAttributeValue ()=0
	Reads next attribute's value. More...

virtual DateTime	ReadContentAsDateTime ()
	Concatenates values of textual nodes of the current content, ignoring comments and PIs, expanding entity references, and converts the content to a DateTime. Stops at start tags and end tags. More...

virtual DateTime	ReadElementContentAsDateTime ()
	Returns the content of the current element as a DateTime. Moves to the node following the element's end tag. More...

virtual DateTime	ReadElementContentAsDateTime (const String &localName, const String &namespaceURI)
	Checks local name and namespace of the current element and returns its content as a DateTime. Moves to the node following the element's end tag. More...

virtual int	ReadElementContentAsInt (const String &localName, const String &namespaceURI)
	Checks if the current node is an element whose local name and namespce URI match the specified values and returns its content as 32-bit integer value. More...

virtual int	ReadElementContentAsInt ()
	Returns the content of the current element as an int. Moves to the node following the element's end tag. More...

virtual int	ReadElementContentAsBase64 (const ArrayPtr< uint8_t > &buffer, int index, int count)
	Call this methods until it returns 0 to get all the data. More...

virtual bool	ReadElementContentAsBoolean ()
	Returns the content of the current element as a boolean. Moves to the node following the element's end tag. More...

virtual bool	ReadElementContentAsBoolean (const String &localName, const String &namespaceURI)
	Checks if the current node is an element whose local name and namespce URI match the specified values and returns its content as boolean value. More...

virtual String	ReadElementContentAsString (const String &localName, const String &namespaceURI)
	Checks if the current node is an element whose local name and namespce URI match the specified values and returns its content as string. More...

virtual String	ReadElementContentAsString ()
	Returns the content of the current element as a string. Moves to the node following the element's end tag. More...

virtual void	ReadEndElement ()
	Determines if the current content node is an end tag and advances the reader to the next node. More...

virtual bool	IsStartElement ()
	Calls MoveToContent() and then determines if the current node is a start tag or an empty element tag. More...

virtual bool	IsStartElement (const String &name)
	Calls MoveToContent() and then determines if the current node is a start tag or an empty element tag and if the found node's qualified name matches the specified value. More...

virtual bool	IsStartElement (const String &name, const String &ns)
	Calls MoveToContent() and then determines if the current node is a start tag or an empty element tag and if the found node's qualified name matches the specified value. More...

virtual String	ReadElementString ()=0
	Reads the contents of a text-only element. More...

virtual String	ReadElementString (const String &value)=0
	Checks if the current node is an element whose qualified name matches the specified value and reads its content. More...

virtual String	ReadElementString (const String &localName, const String &namespaceUri)=0
	Checks if the current node is an element whose local name and namespce URI match the specified values and returns its content as string. More...

virtual void	ResolveEntity ()=0
	resolves the entity reference for EntityReference nodes. More...

virtual SharedPtr< XmlReaderSettings >	get_Settings () const
	Returns the settings of the XmlReader. More...

xmlTextReader *	native () const
	Returns a pointer to the underlying libxml2 xmlTextReader object. More...

xmlDoc *	native_doc ()
	Returns a pointer to the current document used by the xmlTextReader object. More...

virtual void	RaiseLastError ()

Public Member Functions inherited from System::IDisposable
virtual void	Dispose ()
	Does nothing. More...

Public Member Functions inherited from System::Object
	Object ()
	Creates object. Initializes all internal data structures. More...

virtual	~Object ()
	Destroys object. Frees all internal data structures. More...

	Object (Object const &x)
	Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	SharedRefRemovedSafe ()
	Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	RemovedSharedRefs (int count)
	Decreases shared reference count by specified value. More...

Detail::SmartPtrCounter *	WeakRefAdded ()
	Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

void	WeakRefRemoved ()
	Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

Detail::SmartPtrCounter *	GetCounter ()
	Gets reference counter data structure associated with the object. More...

int	SharedCount () const
	Gets current value of shared reference counter. More...

void	Lock ()
	Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...

void	Unlock ()
	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...

virtual bool	Equals (ptr obj)
	Compares objects using C# Object.Equals semantics. More...

virtual int32_t	GetHashCode () const
	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...

virtual String	ToString () const
	Analog of C# Object.ToString() method. Enables converting custom objects to string. More...

virtual ptr	MemberwiseClone () const
	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...

virtual const TypeInfo &	GetType () const
	Gets actual type of object. Analog of C# System.Object.GetType() call. More...

virtual bool	Is (const TypeInfo &targetType) const
	Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...

virtual void	SetTemplateWeakPtr (uint32_t argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...

virtual bool	FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
	For internal purposes only. More...

template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)
	Specialization of Object::ReferenceEquals for case of string and nullptr. More...

template<>
bool	ReferenceEquals (String const &str1, String const &str2)
	Specialization of Object::ReferenceEquals for case of strings. More...

Static Public Member Functions
static XmlReader::Ptr	Create (const String &inputUri)
	Constructs an instance of the XmlReader class that reads XML data from the specified file. More...

static XmlReader::Ptr	Create (const SharedPtr< System::IO::Stream > &input)
	Constructs an instance of the XmlReader class that reads XML data from the specified stream. More...

static XmlReader::Ptr	Create (const SharedPtr< System::IO::TextReader > &input)
	Constructs an instance of the XmlReader class that reads XML data from the specified TextReader. More...

static XmlReader::Ptr	Create (const String &inputUri, const SharedPtr< XmlReaderSettings > &settings)
	Constructs an instance of the XmlReader class that reads XML data from the specified file using the specified settings. More...

static XmlReader::Ptr	Create (const SharedPtr< System::IO::Stream > &input, const SharedPtr< XmlReaderSettings > &settings)
	Constructs an instance of the XmlReader class that reads XML data from the specified stream using the specified settings. More...

static XmlReader::Ptr	Create (const SharedPtr< System::IO::Stream > &input, const SharedPtr< XmlReaderSettings > &settings, const String &baseUri)
	NOT IMPLEMENTED. More...

static XmlReader::Ptr	Create (const SharedPtr< System::IO::TextReader > &input, const SharedPtr< XmlReaderSettings > &settings)
	Constructs an instance of the XmlReader class that reads XML data from the specified TextReader using the specified settings. More...

static XmlReader::Ptr	Create (const SharedPtr< System::IO::TextReader > &input, const SharedPtr< XmlReaderSettings > &settings, const SharedPtr< XmlParserContext > &inputContext)
	Constructs an instance of the XmlReader class that reads XML data from the specified TextReader using the specified settings and cotext information for parsing. More...

static XmlReader::Ptr	Create (const SharedPtr< System::IO::Stream > &input, const SharedPtr< XmlReaderSettings > &settings, const SharedPtr< XmlParserContext > &inputContext)
	Constructs an instance of the XmlReader class that reads XML data from the specified stream using the specified settings and cotext information for parsing. More...

static XmlReader::Ptr	Create (const SharedPtr< System::IO::TextReader > &input, const SharedPtr< XmlReaderSettings > &settings, const System::String &baseUrl)
	Constructs an instance of the XmlReader class that reads XML data from the specified TextReader using the specified settings and base URI. More...

static XmlReader::Ptr	Create (const XmlReader::Ptr &input, const SharedPtr< XmlReaderSettings > &settings)
	Constructs an instance of the XmlReader class that uses the specified XmlReader object as underlying reader. More...

Static Public Member Functions inherited from System::Object
static bool	ReferenceEquals (ptr const &objA, ptr const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, T const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, std::nullptr_t)
	Reference-compares value type object with nullptr. More...

template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares reference type objects in C# style. More...

template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares value type objects in C# style. More...

static const TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct. More...

template<>
bool	Equals (float const &objA, float const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

template<>
bool	Equals (double const &objA, double const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

Protected Member Functions
	XmlReader ()
	Constructs an instance of XmlReader class. More...

Static Protected Member Functions
static bool	is_content (XmlNodeType type)
	Determines if the node of the specified type is a content node. More...

Detailed Description

Provides non-cached forward-only access to XML data. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Member Typedef Documentation

◆ Ptr

typedef SharedPtr<XmlReader> System::Xml::XmlReader::Ptr

An alias for shared pointer to an instance of this class.

Constructor & Destructor Documentation

◆ XmlReader()

System::Xml::XmlReader::XmlReader ( )

protected

Constructs an instance of XmlReader class.

Member Function Documentation

◆ Close()

virtual void System::Xml::XmlReader::Close ( )

pure virtual

Changes the state of the reader to ReadState::Closed.

Implemented in System::Xml::XmlTextReader.

◆ Create() [1/11]

static XmlReader::Ptr System::Xml::XmlReader::Create ( const SharedPtr< System::IO::Stream > & input )

static

Constructs an instance of the XmlReader class that reads XML data from the specified stream.

Parameters

input A System::IO::Stream object to read the XML data from

Returns: A shared pointer to the created XmlReader

◆ Create() [2/11]

static XmlReader::Ptr System::Xml::XmlReader::Create	(	const SharedPtr< System::IO::Stream > &	input,
		const SharedPtr< XmlReaderSettings > &	settings
	)

static

Constructs an instance of the XmlReader class that reads XML data from the specified stream using the specified settings.

Parameters

input	A System::IO::Stream object to read the XML data from
settings	The settings of the XmlReader being created

Returns: A shared pointer to the created XmlReader

◆ Create() [3/11]

static XmlReader::Ptr System::Xml::XmlReader::Create	(	const SharedPtr< System::IO::Stream > &	input,
		const SharedPtr< XmlReaderSettings > &	settings,
		const SharedPtr< XmlParserContext > &	inputContext
	)

static

Constructs an instance of the XmlReader class that reads XML data from the specified stream using the specified settings and cotext information for parsing.

Parameters

input	A System::IO::Stream object to read the XML data from
settings	The settings of the XmlReader being created
inputContext	The context information used to parse the XML fragment

Returns: A shared pointer to the created XmlReader

◆ Create() [4/11]

static XmlReader::Ptr System::Xml::XmlReader::Create	(	const SharedPtr< System::IO::Stream > &	input,
		const SharedPtr< XmlReaderSettings > &	settings,
		const String &	baseUri
	)

static

NOT IMPLEMENTED.

Exceptions

NotImplementedException

◆ Create() [5/11]

static XmlReader::Ptr System::Xml::XmlReader::Create ( const SharedPtr< System::IO::TextReader > & input )

static

Constructs an instance of the XmlReader class that reads XML data from the specified TextReader.

Parameters

input A TextReader object to read the XML data from

Returns: A shared pointer to the created XmlReader

◆ Create() [6/11]

static XmlReader::Ptr System::Xml::XmlReader::Create	(	const SharedPtr< System::IO::TextReader > &	input,
		const SharedPtr< XmlReaderSettings > &	settings
	)

static

Constructs an instance of the XmlReader class that reads XML data from the specified TextReader using the specified settings.

Parameters

input	A TextReader object to read the XML data from
settings	The settings of the XmlReader being created

Returns: A shared pointer to the created XmlReader

◆ Create() [7/11]

static XmlReader::Ptr System::Xml::XmlReader::Create	(	const SharedPtr< System::IO::TextReader > &	input,
		const SharedPtr< XmlReaderSettings > &	settings,
		const SharedPtr< XmlParserContext > &	inputContext
	)

static

Constructs an instance of the XmlReader class that reads XML data from the specified TextReader using the specified settings and cotext information for parsing.

Parameters

input	A TextReader object to read the XML data from
settings	The settings of the XmlReader being created
inputContext	The context information used to parse the XML fragment

Returns: A shared pointer to the created XmlReader

◆ Create() [8/11]

static XmlReader::Ptr System::Xml::XmlReader::Create	(	const SharedPtr< System::IO::TextReader > &	input,
		const SharedPtr< XmlReaderSettings > &	settings,
		const System::String &	baseUrl
	)

static

Constructs an instance of the XmlReader class that reads XML data from the specified TextReader using the specified settings and base URI.

Parameters

input	A TextReader object to read the XML data from
settings	The settings of the XmlReader being created
baseUrl	The base URI for the XML document being read; used to resolve relative URIs in the XML document being read

Returns: A shared pointer to the created XmlReader

◆ Create() [9/11]

static XmlReader::Ptr System::Xml::XmlReader::Create ( const String & inputUri )

static

Constructs an instance of the XmlReader class that reads XML data from the specified file.

Parameters

inputUri URI of the file containing the XML to read

Returns: A shared pointer to the created XmlReader

◆ Create() [10/11]

static XmlReader::Ptr System::Xml::XmlReader::Create	(	const String &	inputUri,
		const SharedPtr< XmlReaderSettings > &	settings
	)

static

Constructs an instance of the XmlReader class that reads XML data from the specified file using the specified settings.

Parameters

inputUri	URI of the file containing the XML to read
settings	The settings of the XmlReader being created

Returns: A shared pointer to the created XmlReader

◆ Create() [11/11]

static XmlReader::Ptr System::Xml::XmlReader::Create	(	const XmlReader::Ptr &	input,
		const SharedPtr< XmlReaderSettings > &	settings
	)

static

Constructs an instance of the XmlReader class that uses the specified XmlReader object as underlying reader.

Parameters

input	A XmlReader object to be used as underlying reader
settings	The settings of the XmlReader being created

Returns: A shared pointer to the created XmlReader

◆ get_AttributeCount()

virtual int System::Xml::XmlReader::get_AttributeCount ( )

pure virtual

Returns the number of attributes in the current node.

Implemented in System::Xml::XmlTextReader.

◆ get_BaseURI()

virtual String System::Xml::XmlReader::get_BaseURI ( )

virtual

Returns the base URI of the current node.

Reimplemented in System::Xml::XmlTextReader.

◆ get_CanResolveEntity()

virtual bool System::Xml::XmlReader::get_CanResolveEntity ( )

virtual

Determines whether the current XmlReader object can parse and resolve entities.

Reimplemented in System::Xml::XmlTextReader.

◆ get_Depth()

virtual int System::Xml::XmlReader::get_Depth ( )

virtual

Returns the depths of the current node in the XML tree.

Reimplemented in System::Xml::XmlTextReader.

◆ get_EOF()

virtual bool System::Xml::XmlReader::get_EOF ( )

virtual

Determines if the reader has reached the end of stream.

Reimplemented in System::Xml::XmlTextReader.

◆ get_HasAttributes()

virtual bool System::Xml::XmlReader::get_HasAttributes ( )

virtual

Determines if the current node has any attributes.

Reimplemented in System::Xml::XmlTextReader.

◆ get_HasValue()

virtual bool System::Xml::XmlReader::get_HasValue ( )

virtual

Determines if the current node has a value.

Reimplemented in System::Xml::XmlTextReader.

◆ get_IsDefault()

virtual bool System::Xml::XmlReader::get_IsDefault ( )

virtual

Determines if the current node is an attribute that was generated from the default value defined in the DTD or schema.

Reimplemented in System::Xml::XmlTextReader.

◆ get_IsEmptyElement()

virtual bool System::Xml::XmlReader::get_IsEmptyElement ( )

pure virtual

Determines if the current node is an empty element.

Implemented in System::Xml::XmlTextReader.

◆ get_LocalName()

virtual String System::Xml::XmlReader::get_LocalName ( )

virtual

Returns the local name of the current node.

Reimplemented in System::Xml::XmlTextReader.

◆ get_Name()

virtual String System::Xml::XmlReader::get_Name ( )

virtual

Returns the qualified name of the current node.

Reimplemented in System::Xml::XmlTextReader.

◆ get_NamespaceURI()

virtual String System::Xml::XmlReader::get_NamespaceURI ( )

virtual

Returns the namespace URI of the current node.

Reimplemented in System::Xml::XmlTextReader.

◆ get_NameTable()

virtual SharedPtr<System::Xml::XmlNameTable> System::Xml::XmlReader::get_NameTable ( )

virtual

Gets name table associated with document being read.

Returns: XmlNameTable object pointer.

Reimplemented in System::Xml::XmlTextReader.

◆ get_NodeType()

virtual XmlNodeType System::Xml::XmlReader::get_NodeType ( )

pure virtual

Returns the type of the current node.

Implemented in System::Xml::XmlTextReader.

◆ get_Prefix()

virtual String System::Xml::XmlReader::get_Prefix ( )

virtual

Returns the prefix of the current node.

Reimplemented in System::Xml::XmlTextReader.

◆ get_QuoteChar()

virtual UChar System::Xml::XmlReader::get_QuoteChar ( )

virtual

Returns the used as quotation mark character used to enclose the value of an XML attribute node.

Reimplemented in System::Xml::XmlTextReader.

◆ get_ReadState()

virtual ReadState System::Xml::XmlReader::get_ReadState ( )

virtual

Returns the current state of the reader.

Reimplemented in System::Xml::XmlTextReader.

◆ get_SchemaInfo()

virtual SharedPtr<Schema::IXmlSchemaInfo> System::Xml::XmlReader::get_SchemaInfo ( )

virtual

Reimplemented in System::Xml::XmlTextReader.

◆ get_Settings()

virtual SharedPtr<XmlReaderSettings> System::Xml::XmlReader::get_Settings ( ) const

virtual

Returns the settings of the XmlReader.

Returns: The settings object

Reimplemented in System::Xml::XmlTextReader.

◆ get_Value()

virtual String System::Xml::XmlReader::get_Value ( )

pure virtual

Returns the value of the current node.

Implemented in System::Xml::XmlTextReader.

◆ get_XmlLang()

virtual String System::Xml::XmlReader::get_XmlLang ( )

virtual

Returns the current xml:lang scope.

Reimplemented in System::Xml::XmlTextReader.

◆ GetAttribute() [1/3]

virtual String System::Xml::XmlReader::GetAttribute	(	const String &	localName,
		const String &	namespaceURI
	)

virtual

Gets the value of the attribute with the specified local name and namespace URI.

Parameters

localName	The local name of the attribute.
namespaceURI	The namespace URI of the attribute.

Returns: The value of the specified attribute. If the attribute is not found, null is returned. This method does not move the reader.

Reimplemented in System::Xml::XmlTextReader.

◆ GetAttribute() [2/3]

virtual String System::Xml::XmlReader::GetAttribute ( const String & name )

virtual

Returns the value of the attribute with the specified name.

Parameters

name	The qualified name of the attribute

Returns: The value of the attribute with name name

Reimplemented in System::Xml::XmlTextReader.

◆ GetAttribute() [3/3]

virtual String System::Xml::XmlReader::GetAttribute ( int32_t index )

virtual

Returns the value of the attribute with the specified index.

Parameters

index A 0-based index of the attribute in the list of attributes of the current node

Returns: The value of the attribute with index index

◆ idx_get()

String System::Xml::XmlReader::idx_get ( const String & name )

Returns the value of the attribute with the specified name.

Parameters

name	The name of the attribute

Returns: The value of the attribute whose name is name

◆ is_content()

static bool System::Xml::XmlReader::is_content ( XmlNodeType type )

staticprotected

Determines if the node of the specified type is a content node.

Parameters

type	The node type to check.

Returns: True if the specified node type is a content node, otherwise - false

◆ IsStartElement() [1/3]

virtual bool System::Xml::XmlReader::IsStartElement ( )

virtual

Calls MoveToContent() and then determines if the current node is a start tag or an empty element tag.

Returns: True if the current node is a start tag or an empty element tag, otherwise - false

◆ IsStartElement() [2/3]

virtual bool System::Xml::XmlReader::IsStartElement ( const String & name )

virtual

Calls MoveToContent() and then determines if the current node is a start tag or an empty element tag and if the found node's qualified name matches the specified value.

Parameters

name	The string to match the node's qualified name against

Returns: True if the current node is a start tag or an empty element tag and its qualified name matches name, otherwise - false

◆ IsStartElement() [3/3]

virtual bool System::Xml::XmlReader::IsStartElement	(	const String &	name,
		const String &	ns
	)

virtual

Calls MoveToContent() and then determines if the current node is a start tag or an empty element tag and if the found node's qualified name matches the specified value.

Parameters

name	The string to match the node's name against
ns	The string to match the node's namespace against

Returns: True if the current node is a start tag or an empty element tag and its qualified name matches name, otherwise - false

◆ LookupNamespace()

virtual String System::Xml::XmlReader::LookupNamespace ( const String & prefix )

pure virtual

Resolves a namespace prefix in the scope of the current element.

Parameters

prefix The prefix to resove

Returns: The namespace URI associated with the specified prefix

Implemented in System::Xml::XmlTextReader.

◆ MoveToAttribute() [1/2]

virtual bool System::Xml::XmlReader::MoveToAttribute ( const String & name )

virtual

Moves the reader's position to the attribute with the specified name.

Parameters

name	The qualified name of the attribute to move the position to

Returns: True if the operation succeeded, otherwise - false

Reimplemented in System::Xml::XmlTextReader.

◆ MoveToAttribute() [2/2]

virtual void System::Xml::XmlReader::MoveToAttribute ( int index )

virtual

Moves the reader's position to the attribute with the specified index.

Parameters

index A 0-based index of the attribute in the list of attributes of the current node

Reimplemented in System::Xml::XmlTextReader.

◆ MoveToContent()

virtual XmlNodeType System::Xml::XmlReader::MoveToContent ( )

pure virtual

Moves the position of the reader to the next content node, skipping the non-content nodes.

Returns: The type of the node to which the reader's position was moved

Implemented in System::Xml::XmlTextReader.

◆ MoveToElement()

virtual bool System::Xml::XmlReader::MoveToElement ( )

pure virtual

Moves the reader's position to the element node that contains the current attribute node.

Returns: True if the operation succeeded, otherwise - false

Implemented in System::Xml::XmlTextReader.

◆ MoveToFirstAttribute()

virtual bool System::Xml::XmlReader::MoveToFirstAttribute ( )

virtual

Moves the reader's position to the first attribute in the list of attributes of the current node.

Returns: True if the operation succeeded, otherwise - false

Reimplemented in System::Xml::XmlTextReader.

◆ MoveToNextAttribute()

virtual bool System::Xml::XmlReader::MoveToNextAttribute ( )

virtual

Moves the reader's position to the next attribute.

Returns: True if the operation succeeded, otherwise - false

Reimplemented in System::Xml::XmlTextReader.

◆ native()

xmlTextReader* System::Xml::XmlReader::native ( ) const

inline

Returns a pointer to the underlying libxml2 xmlTextReader object.

◆ native_doc()

xmlDoc* System::Xml::XmlReader::native_doc ( )

Returns a pointer to the current document used by the xmlTextReader object.

◆ Next()

virtual bool System::Xml::XmlReader::Next ( )

virtual

Navigates to the next token.

Returns: True if successful, false otherwise.

Reimplemented in System::Xml::XmlTextReader.

◆ RaiseLastError()

virtual void System::Xml::XmlReader::RaiseLastError ( )

virtual

Reimplemented in System::Xml::XmlTextReader.

◆ Read()

virtual bool System::Xml::XmlReader::Read ( )

pure virtual

Reads the next node.

Returns: True if the operation succeeded, otherwise - false

Implemented in System::Xml::XmlTextReader.

◆ ReadAttributeValue()

virtual bool System::Xml::XmlReader::ReadAttributeValue ( )

pure virtual

Reads next attribute's value.

Returns: True if attribute is read, false otherwise.

Implemented in System::Xml::XmlTextReader.

◆ ReadContentAsBoolean()

virtual bool System::Xml::XmlReader::ReadContentAsBoolean ( )

virtual

Reads current element's contents as boolean.

Returns: Boolean representation of current element's contents.

◆ ReadContentAsDateTime()

virtual DateTime System::Xml::XmlReader::ReadContentAsDateTime ( )

virtual

Concatenates values of textual nodes of the current content, ignoring comments and PIs, expanding entity references, and converts the content to a DateTime. Stops at start tags and end tags.

Returns: Content as DateTime value

◆ ReadContentAsDecimal()

virtual Decimal System::Xml::XmlReader::ReadContentAsDecimal ( )

virtual

Reads current element's contents as decimal.

Returns: Decimal representation of current element's contents.

◆ ReadContentAsDouble()

virtual double System::Xml::XmlReader::ReadContentAsDouble ( )

virtual

Reads current element's contents as double.

Returns: Double representation of current element's contents.

◆ ReadContentAsFloat()

virtual float System::Xml::XmlReader::ReadContentAsFloat ( )

virtual

Reads current element's contents as float.

Returns: Float representation of current element's contents.

◆ ReadContentAsInt()

virtual int32_t System::Xml::XmlReader::ReadContentAsInt ( )

virtual

Reads current element's contents as integer.

Returns: Integer representation of current element's contents.

◆ ReadContentAsLong()

virtual int64_t System::Xml::XmlReader::ReadContentAsLong ( )

virtual

Reads current element's contents as long integer.

Returns: 64-bit integer representation of current element's contents.

◆ ReadContentAsString()

virtual String System::Xml::XmlReader::ReadContentAsString ( )

virtual

Reads current element's contents as string.

Returns: String representation of current element's contents.

◆ ReadElementContentAsBase64()

virtual int System::Xml::XmlReader::ReadElementContentAsBase64	(	const ArrayPtr< uint8_t > &	buffer,
		int	index,
		int	count
	)

virtual

Call this methods until it returns 0 to get all the data.

Returns: Decoded bytes of the current base64 element content

Reimplemented in System::Xml::XmlTextReader.

◆ ReadElementContentAsBoolean() [1/2]

virtual bool System::Xml::XmlReader::ReadElementContentAsBoolean ( )

virtual

Returns the content of the current element as a boolean. Moves to the node following the element's end tag.

Returns: The element's content as boolean

◆ ReadElementContentAsBoolean() [2/2]

virtual bool System::Xml::XmlReader::ReadElementContentAsBoolean	(	const String &	localName,
		const String &	namespaceURI
	)

virtual

Checks if the current node is an element whose local name and namespce URI match the specified values and returns its content as boolean value.

Parameters

localName	The local name of the element
namespaceURI	The namespace URI of the element

Returns: The element's content as boolean

◆ ReadElementContentAsDateTime() [1/2]

virtual DateTime System::Xml::XmlReader::ReadElementContentAsDateTime ( )

virtual

Returns the content of the current element as a DateTime. Moves to the node following the element's end tag.

Returns: The element's content as DateTime value

◆ ReadElementContentAsDateTime() [2/2]

virtual DateTime System::Xml::XmlReader::ReadElementContentAsDateTime	(	const String &	localName,
		const String &	namespaceURI
	)

virtual

Checks local name and namespace of the current element and returns its content as a DateTime. Moves to the node following the element's end tag.

Parameters

localName	The local name of the element
namespaceURI	The namespace URI of the element

Returns: The element's content as DateTime value

◆ ReadElementContentAsInt() [1/2]

virtual int System::Xml::XmlReader::ReadElementContentAsInt ( )

virtual

Returns the content of the current element as an int. Moves to the node following the element's end tag.

Returns: The element's content as 32-bit integer value

◆ ReadElementContentAsInt() [2/2]

virtual int System::Xml::XmlReader::ReadElementContentAsInt	(	const String &	localName,
		const String &	namespaceURI
	)

virtual

Checks if the current node is an element whose local name and namespce URI match the specified values and returns its content as 32-bit integer value.

Parameters

localName	The local name of the element
namespaceURI	The namespace URI of the element

Returns: The element's content as 32-bit integer value

◆ ReadElementContentAsString() [1/2]

virtual String System::Xml::XmlReader::ReadElementContentAsString ( )

virtual

Returns the content of the current element as a string. Moves to the node following the element's end tag.

Returns: The element's content as string

◆ ReadElementContentAsString() [2/2]

virtual String System::Xml::XmlReader::ReadElementContentAsString	(	const String &	localName,
		const String &	namespaceURI
	)

virtual

Checks if the current node is an element whose local name and namespce URI match the specified values and returns its content as string.

Parameters

localName	The local name of the element
namespaceURI	The namespace URI of the element

Returns: The element's content as string

◆ ReadElementString() [1/3]

virtual String System::Xml::XmlReader::ReadElementString ( )

pure virtual

Reads the contents of a text-only element.

Returns: The contents of the current element

Implemented in System::Xml::XmlTextReader.

◆ ReadElementString() [2/3]

virtual String System::Xml::XmlReader::ReadElementString	(	const String &	localName,
		const String &	namespaceUri
	)

pure virtual

Checks if the current node is an element whose local name and namespce URI match the specified values and returns its content as string.

Parameters

localName	The local name of the element
namespaceUri	The namespace URI of the element

Returns: The element's content as a string

Implemented in System::Xml::XmlTextReader.

◆ ReadElementString() [3/3]

virtual String System::Xml::XmlReader::ReadElementString ( const String & value )

pure virtual

Checks if the current node is an element whose qualified name matches the specified value and reads its content.

Parameters

value The element's qualified name

Returns: The contents of the current element as a string

Implemented in System::Xml::XmlTextReader.

◆ ReadEndElement()

virtual void System::Xml::XmlReader::ReadEndElement ( )

virtual

Determines if the current content node is an end tag and advances the reader to the next node.

◆ ReadInnerXml()

virtual String System::Xml::XmlReader::ReadInnerXml ( )

pure virtual

Returns a string containing all the content of the current node, including the markup, but excluding start and end tags.

Implemented in System::Xml::XmlTextReader.

◆ ReadOuterXml()

virtual String System::Xml::XmlReader::ReadOuterXml ( )

pure virtual

Returns a string containing all the content of the current node, including the markup, and including start and end tags.

Implemented in System::Xml::XmlTextReader.

◆ ReadStartElement() [1/3]

virtual void System::Xml::XmlReader::ReadStartElement ( )

pure virtual

Checks if the current content node is an element and moves the the reader's position to the next node.

Implemented in System::Xml::XmlTextReader.

◆ ReadStartElement() [2/3]

virtual void System::Xml::XmlReader::ReadStartElement	(	const String &	localName,
		const String &	namespaceUri
	)

pure virtual

Checks if the current content node is an element with the specified local name and namespace URI and moves the the reader's position to the next node.

Parameters

localName	The element's local name
namespaceUri	The element's namespace URI

Implemented in System::Xml::XmlTextReader.

◆ ReadStartElement() [3/3]

virtual void System::Xml::XmlReader::ReadStartElement ( const String & value )

pure virtual

Checks if the current content node is an element with the specified qualified name and moves the the reader's position to the next node.

Parameters

value The element's qualified name

Implemented in System::Xml::XmlTextReader.

◆ ReadString()

virtual String System::Xml::XmlReader::ReadString ( )

pure virtual

Reads the contents of an element or a text node.

Returns: The contents of an element or a text node as a string.

Implemented in System::Xml::XmlTextReader.

◆ ReadSubtree()

virtual Ptr System::Xml::XmlReader::ReadSubtree ( )

virtual

Read an element and all its children, and return a new XmlReader object set to ReadState::Initial.

◆ ReadToDescendant() [1/2]

virtual bool System::Xml::XmlReader::ReadToDescendant	(	const String &	localName,
		const String &	namespaceURI
	)

virtual

Parameters

localName	The local name of the element to move to.
namespaceURI	The namespce URI of the element to move to.

Returns: True if a matching descendant element is found; otherwise false.

◆ ReadToDescendant() [2/2]

virtual bool System::Xml::XmlReader::ReadToDescendant ( const String & name )

virtual

Reads to the first descendant of the current element with the given name.

Parameters

name	The qualified name of the element to move to.

Returns: True if a matching descendant element is found; otherwise false.

◆ ReadToFollowing() [1/2]

virtual bool System::Xml::XmlReader::ReadToFollowing	(	const String &	localName,
		const String &	namespaceURI
	)

virtual

Reads until an element with the specified local name name and namespace URI is encountered.

Parameters

localName	The local name of the element to read until
namespaceURI	The namespce URI of the element to read until

Returns: True if the node with the specified local name and namespace URI has been found, otherwise - false

◆ ReadToFollowing() [2/2]

virtual bool System::Xml::XmlReader::ReadToFollowing ( const String & name )

virtual

Reads until an element with the specified name is encountered.

Parameters

name	The qualified name of the element to read until

Returns: True if the node with the specified qualified name has been found, otherwise - false

◆ ReadToNextSibling()

virtual bool System::Xml::XmlReader::ReadToNextSibling ( const String & name )

virtual

Moves the position of the reader to the next sibling with the specified name.

Parameters

name	The name of the sibling to move the reader's position to

Returns: True if the sibling node with the specified qualified name has been found, otherwise - false

◆ ResolveEntity()

virtual void System::Xml::XmlReader::ResolveEntity ( )

pure virtual

resolves the entity reference for EntityReference nodes.

Implemented in System::Xml::XmlTextReader.

◆ Skip()

virtual void System::Xml::XmlReader::Skip ( )

pure virtual

Skips the children of the current node.

Implemented in System::Xml::XmlTextReader.

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ XmlReader()

Member Function Documentation

◆ Close()

◆ Create() [1/11]

◆ Create() [2/11]

◆ Create() [3/11]

◆ Create() [4/11]

◆ Create() [5/11]

◆ Create() [6/11]

◆ Create() [7/11]

◆ Create() [8/11]

◆ Create() [9/11]

◆ Create() [10/11]

◆ Create() [11/11]

◆ get_AttributeCount()

◆ get_BaseURI()

◆ get_CanResolveEntity()

◆ get_Depth()

◆ get_EOF()

◆ get_HasAttributes()

◆ get_HasValue()

◆ get_IsDefault()

◆ get_IsEmptyElement()

◆ get_LocalName()

◆ get_Name()

◆ get_NamespaceURI()

◆ get_NameTable()

◆ get_NodeType()

◆ get_Prefix()

◆ get_QuoteChar()

◆ get_ReadState()

◆ get_SchemaInfo()

◆ get_Settings()

◆ get_Value()

◆ get_XmlLang()

◆ GetAttribute() [1/3]

◆ GetAttribute() [2/3]

◆ GetAttribute() [3/3]

◆ idx_get()

◆ is_content()

◆ IsStartElement() [1/3]

◆ IsStartElement() [2/3]

◆ IsStartElement() [3/3]

◆ LookupNamespace()

◆ MoveToAttribute() [1/2]

◆ MoveToAttribute() [2/2]

◆ MoveToContent()

◆ MoveToElement()

◆ MoveToFirstAttribute()

◆ MoveToNextAttribute()

◆ native()

◆ native_doc()

◆ Next()

◆ RaiseLastError()

◆ Read()

◆ ReadAttributeValue()

◆ ReadContentAsBoolean()

◆ ReadContentAsDateTime()

◆ ReadContentAsDecimal()

◆ ReadContentAsDouble()

◆ ReadContentAsFloat()

◆ ReadContentAsInt()

◆ ReadContentAsLong()

◆ ReadContentAsString()

◆ ReadElementContentAsBase64()

◆ ReadElementContentAsBoolean() [1/2]

◆ ReadElementContentAsBoolean() [2/2]

◆ ReadElementContentAsDateTime() [1/2]

◆ ReadElementContentAsDateTime() [2/2]

◆ ReadElementContentAsInt() [1/2]

◆ ReadElementContentAsInt() [2/2]