Represents a reader that provides fast, noncached, forward-only access to XML data. More...

#include <xml_reader.h>

Inherited by System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

Public Types
using	Ptr = SharedPtr< XmlReader >
	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 SharedPtr< XmlReaderSettings >	get_Settings ()
	Returns the XmlReaderSettings object used to create this XmlReader instance. More...

virtual XmlNodeType	get_NodeType ()=0
	When overridden in a derived class, gets the type of the current node. More...

virtual String	get_Name ()
	When overridden in a derived class, gets the qualified name of the current node. More...

virtual String	get_LocalName ()=0
	When overridden in a derived class, gets the local name of the current node. More...

virtual String	get_NamespaceURI ()=0
	When overridden in a derived class, gets the namespace URI (as defined in the W3C Namespace specification) of the node on which the reader is positioned. More...

virtual String	get_Prefix ()=0
	When overridden in a derived class, gets the namespace prefix associated with the current node. More...

virtual bool	get_HasValue ()
	When overridden in a derived class, gets a value indicating whether the current node can have a XmlReader::get_Value value. More...

virtual String	get_Value ()=0
	When overridden in a derived class, gets the text value of the current node. More...

virtual int32_t	get_Depth ()=0
	When overridden in a derived class, gets the depth of the current node in the XML document. More...

virtual String	get_BaseURI ()=0
	When overridden in a derived class, gets the base URI of the current node. More...

virtual bool	get_IsEmptyElement ()=0
	When overridden in a derived class, gets a value indicating whether the current node is an empty element (for example, `<MyElement/>`). More...

virtual bool	get_IsDefault ()
	When overridden in a derived class, gets a value indicating whether the current node is an attribute that was generated from the default value defined in the DTD or schema. More...

virtual char16_t	get_QuoteChar ()
	When overridden in a derived class, gets the quotation mark character used to enclose the value of an attribute node. More...

virtual System::Xml::XmlSpace	get_XmlSpace ()
	When overridden in a derived class, gets the current `xml:space` scope. More...

virtual String	get_XmlLang ()
	When overridden in a derived class, gets the current `xml:lang` scope. More...

virtual SharedPtr< Schema::IXmlSchemaInfo >	get_SchemaInfo ()
	Returns the schema information that has been assigned to the current node as a result of schema validation. More...

virtual TypeInfo	get_ValueType ()
	Returns The type for the current node. More...

virtual int32_t	get_AttributeCount ()=0
	When overridden in a derived class, gets the number of attributes on the current node. More...

virtual bool	get_EOF ()=0
	When overridden in a derived class, gets a value indicating whether the reader is positioned at the end of the stream. More...

virtual System::Xml::ReadState	get_ReadState ()=0
	When overridden in a derived class, gets the state of the reader. More...

virtual SharedPtr< XmlNameTable >	get_NameTable ()=0
	When overridden in a derived class, gets the XmlNameTable associated with this implementation. More...

virtual bool	get_CanResolveEntity ()
	Returns a value indicating whether this reader can parse and resolve entities. More...

virtual bool	get_CanReadBinaryContent ()
	Returns a value indicating whether the XmlReader implements the binary content read methods. More...

virtual bool	get_CanReadValueChunk ()
	Returns a value indicating whether the XmlReader implements the XmlReader::ReadValueChunk method. More...

virtual bool	get_HasAttributes ()
	Returns a value indicating whether the current node has any attributes. More...

virtual SharedPtr< Object >	ReadContentAsObject ()
	Reads the text content at the current position as an Object. More...

virtual bool	ReadContentAsBoolean ()
	Reads the text content at the current position as a Boolean. More...

virtual DateTime	ReadContentAsDateTime ()
	Reads the text content at the current position as a DateTime object. More...

virtual DateTimeOffset	ReadContentAsDateTimeOffset ()
	Reads the text content at the current position as a DateTimeOffset object. More...

virtual double	ReadContentAsDouble ()
	Reads the text content at the current position as a double-precision floating-point number. More...

virtual float	ReadContentAsFloat ()
	Reads the text content at the current position as a single-precision floating point number. More...

virtual Decimal	ReadContentAsDecimal ()
	Reads the text content at the current position as a Decimal object. More...

virtual int32_t	ReadContentAsInt ()
	Reads the text content at the current position as a 32-bit signed integer. More...

virtual int64_t	ReadContentAsLong ()
	Reads the text content at the current position as a 64-bit signed integer. More...

virtual String	ReadContentAsString ()
	Reads the text content at the current position as a String object. More...

virtual SharedPtr< Object >	ReadContentAs (const TypeInfo &returnType, SharedPtr< IXmlNamespaceResolver > namespaceResolver)
	Reads the content as an object of the type specified. More...

virtual SharedPtr< Object >	ReadElementContentAsObject ()
	Reads the current element and returns the contents as an Object. More...

virtual SharedPtr< Object >	ReadElementContentAsObject (String localName, String namespaceURI)
	Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as an Object. More...

virtual bool	ReadElementContentAsBoolean ()
	Reads the current element and returns the contents as a Boolean object. More...

virtual bool	ReadElementContentAsBoolean (String localName, String namespaceURI)
	Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a Boolean object. More...

virtual DateTime	ReadElementContentAsDateTime ()
	Reads the current element and returns the contents as a DateTime object. More...

virtual DateTime	ReadElementContentAsDateTime (String localName, String namespaceURI)
	Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a DateTime object. More...

virtual double	ReadElementContentAsDouble ()
	Reads the current element and returns the contents as a double-precision floating-point number. More...

virtual double	ReadElementContentAsDouble (String localName, String namespaceURI)
	Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a double-precision floating-point number. More...

virtual float	ReadElementContentAsFloat ()
	Reads the current element and returns the contents as single-precision floating-point number. More...

virtual float	ReadElementContentAsFloat (String localName, String namespaceURI)
	Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a single-precision floating-point number. More...

virtual Decimal	ReadElementContentAsDecimal ()
	Reads the current element and returns the contents as a Decimal object. More...

virtual Decimal	ReadElementContentAsDecimal (String localName, String namespaceURI)
	Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a Decimal object. More...

virtual int32_t	ReadElementContentAsInt ()
	Reads the current element and returns the contents as a 32-bit signed integer. More...

virtual int32_t	ReadElementContentAsInt (String localName, String namespaceURI)
	Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a 32-bit signed integer. More...

virtual int64_t	ReadElementContentAsLong ()
	Reads the current element and returns the contents as a 64-bit signed integer. More...

virtual int64_t	ReadElementContentAsLong (String localName, String namespaceURI)
	Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a 64-bit signed integer. More...

virtual String	ReadElementContentAsString ()
	Reads the current element and returns the contents as a String object. More...

virtual String	ReadElementContentAsString (String localName, String namespaceURI)
	Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a String object. More...

virtual SharedPtr< Object >	ReadElementContentAs (const TypeInfo &returnType, SharedPtr< IXmlNamespaceResolver > namespaceResolver)
	Reads the element content as the requested type. More...

virtual SharedPtr< Object >	ReadElementContentAs (const TypeInfo &returnType, SharedPtr< IXmlNamespaceResolver > namespaceResolver, String localName, String namespaceURI)
	Checks that the specified local name and namespace URI matches that of the current element, then reads the element content as the requested type. More...

virtual String	GetAttribute (String name)=0
	When overridden in a derived class, gets the value of the attribute with the specified XmlReader::get_Name value. More...

virtual String	GetAttribute (String name, String namespaceURI)=0
	When overridden in a derived class, gets the value of the attribute with the specified XmlReader::get_LocalName and XmlReader::get_NamespaceURI values. More...

virtual String	GetAttribute (int32_t i)=0
	When overridden in a derived class, gets the value of the attribute with the specified index. More...

virtual String	idx_get (int32_t i)
	When overridden in a derived class, gets the value of the attribute with the specified index. More...

virtual String	idx_get (String name)
	When overridden in a derived class, gets the value of the attribute with the specified XmlReader::get_Name value. More...

virtual String	idx_get (String name, String namespaceURI)
	When overridden in a derived class, gets the value of the attribute with the specified XmlReader::get_LocalName and XmlReader::get_NamespaceURI values. More...

virtual bool	MoveToAttribute (String name)=0
	When overridden in a derived class, moves to the attribute with the specified XmlReader::get_Name value. More...

virtual bool	MoveToAttribute (String name, String ns)=0
	When overridden in a derived class, moves to the attribute with the specified XmlReader::get_LocalName and XmlReader::get_NamespaceURI values. More...

virtual void	MoveToAttribute (int32_t i)
	When overridden in a derived class, moves to the attribute with the specified index. More...

virtual bool	MoveToFirstAttribute ()=0
	When overridden in a derived class, moves to the first attribute. More...

virtual bool	MoveToNextAttribute ()=0
	When overridden in a derived class, moves to the next attribute. More...

virtual bool	MoveToElement ()=0
	When overridden in a derived class, moves to the element that contains the current attribute node. More...

virtual bool	ReadAttributeValue ()=0
	When overridden in a derived class, parses the attribute value into one or more `Text`, `EntityReference`, or `EndEntity` nodes. More...

virtual bool	Read ()=0
	When overridden in a derived class, reads the next node from the stream. More...

virtual void	Close ()
	When overridden in a derived class, changes the XmlReader::get_ReadState to ReadState::Closed. More...

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

virtual String	LookupNamespace (const String &prefix)=0
	When overridden in a derived class, resolves a namespace prefix in the current element's scope. More...

virtual void	ResolveEntity ()=0
	When overridden in a derived class, resolves the entity reference for `EntityReference` nodes. More...

virtual int32_t	ReadContentAsBase64 (ArrayPtr< uint8_t > buffer, int32_t index, int32_t count)
	Reads the content and returns the Base64 decoded binary bytes. More...

virtual int32_t	ReadElementContentAsBase64 (ArrayPtr< uint8_t > buffer, int32_t index, int32_t count)
	Reads the element and decodes the `Base64` content. More...

virtual int32_t	ReadContentAsBinHex (ArrayPtr< uint8_t > buffer, int32_t index, int32_t count)
	Reads the content and returns the `BinHex` decoded binary bytes. More...

virtual int32_t	ReadElementContentAsBinHex (ArrayPtr< uint8_t > buffer, int32_t index, int32_t count)
	Reads the element and decodes the `BinHex` content. More...

virtual int32_t	ReadValueChunk (ArrayPtr< char16_t > buffer, int32_t index, int32_t count)
	Reads large streams of text embedded in an XML document. More...

virtual String	ReadString ()
	When overridden in a derived class, reads the contents of an element or text node as a string. However, it is recommended to use the XmlReader::ReadElementContentAsString method instead, because it provides a more straightforward way to handle this operation. More...

virtual XmlNodeType	MoveToContent ()
	Checks whether the current node is a content (non-white space text, `CDATA`, `Element`, `EndElement`, `EntityReference`, or `EndEntity`) node. If the node is not a content node, the reader skips ahead to the next content node or end of file. It skips over nodes of the following type: `ProcessingInstruction`, `DocumentType`, `Comment`, `Whitespace`, or `SignificantWhitespace`. More...

virtual void	ReadStartElement ()
	Checks that the current node is an element and advances the reader to the next node. More...

virtual void	ReadStartElement (String name)
	Checks that the current content node is an element with the given XmlReader::get_Name value and advances the reader to the next node. More...

virtual void	ReadStartElement (String localname, String ns)
	Checks that the current content node is an element with the given XmlReader::get_LocalName and XmlReader::get_NamespaceURI values and advances the reader to the next node. More...

virtual String	ReadElementString ()
	Reads a text-only element. However, it is recommended to use the XmlReader::ReadElementContentAsString method instead, because it provides a more straightforward way to handle this operation. More...

virtual String	ReadElementString (String name)
	Checks that the XmlReader::get_Name value of the element found matches the given string before reading a text-only element. However, it is recommended to use the XmlReader::ReadElementContentAsString method instead, because it provides a more straightforward way to handle this operation. More...

virtual String	ReadElementString (String localname, String ns)
	Checks that the XmlReader::get_LocalName and XmlReader::get_NamespaceURI values of the element found matches the given strings before reading a text-only element. However, it is recommended to use the XmlReader::ReadElementContentAsString method instead, because it provides a more straightforward way to handle this operation. More...

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

virtual bool	IsStartElement ()
	Calls XmlReader::MoveToContent and tests if the current content node is a start tag or empty element tag. More...

virtual bool	IsStartElement (String name)
	Calls XmlReader::MoveToContent and tests if the current content node is a start tag or empty element tag and if the XmlReader::get_Name value of the element found matches the given argument. More...

virtual bool	IsStartElement (String localname, String ns)
	Calls XmlReader::MoveToContent and tests if the current content node is a start tag or empty element tag and if the XmlReader::get_LocalName and XmlReader::get_NamespaceURI values of the element found match the given strings. More...

virtual bool	ReadToFollowing (String name)
	Reads until an element with the specified qualified name is found. More...

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

virtual bool	ReadToDescendant (String name)
	Advances the XmlReader to the next descendant element with the specified qualified name. More...

virtual bool	ReadToDescendant (String localName, String namespaceURI)
	Advances the XmlReader to the next descendant element with the specified local name and namespace URI. More...

virtual bool	ReadToNextSibling (String name)
	Advances the XmlReader to the next sibling element with the specified qualified name. More...

virtual bool	ReadToNextSibling (String localName, String namespaceURI)
	Advances the XmlReader to the next sibling element with the specified local name and namespace URI. More...

virtual String	ReadInnerXml ()
	When overridden in a derived class, reads all the content, including markup, as a string. More...

virtual String	ReadOuterXml ()
	When overridden in a derived class, reads the content, including markup, representing this node and all its children. More...

virtual SharedPtr< XmlReader >	ReadSubtree ()
	Returns a new XmlReader instance that can be used to read the current node, and all its descendants. More...

void	Dispose () override
	Releases all resources used by the current instance of the XmlReader class. More...

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 bool	IsName (const String &str)
	Returns a value indicating whether the string argument is a valid XML name. More...

static bool	IsNameToken (const String &str)
	Returns a value indicating whether or not the string argument is a valid XML name token. More...

static SharedPtr< XmlReader >	Create (const String &inputUri)
	Creates a new XmlReader instance with specified URI. More...

static SharedPtr< XmlReader >	Create (const String &inputUri, const SharedPtr< XmlReaderSettings > &settings)
	Creates a new XmlReader instance by using the specified URI and settings. More...

static SharedPtr< XmlReader >	Create (const String &inputUri, SharedPtr< XmlReaderSettings > settings, const SharedPtr< XmlParserContext > &inputContext)
	Creates a new XmlReader instance by using the specified URI, settings, and context information for parsing. More...

static SharedPtr< XmlReader >	Create (const SharedPtr< IO::Stream > &input)
	Creates a new XmlReader instance using the specified stream with default settings. More...

static SharedPtr< XmlReader >	Create (const SharedPtr< IO::Stream > &input, const SharedPtr< XmlReaderSettings > &settings)
	Creates a new XmlReader instance with the specified stream and settings. More...

static SharedPtr< XmlReader >	Create (const SharedPtr< IO::Stream > &input, SharedPtr< XmlReaderSettings > settings, const String &baseUri)
	Creates a new XmlReader instance using the specified stream, base URI, and settings. More...

static SharedPtr< XmlReader >	Create (const SharedPtr< IO::Stream > &input, SharedPtr< XmlReaderSettings > settings, const SharedPtr< XmlParserContext > &inputContext)
	Creates a new XmlReader instance using the specified stream, settings, and context information for parsing. More...

static SharedPtr< XmlReader >	Create (const SharedPtr< IO::TextReader > &input)
	Creates a new XmlReader instance by using the specified text reader. More...

static SharedPtr< XmlReader >	Create (const SharedPtr< IO::TextReader > &input, const SharedPtr< XmlReaderSettings > &settings)
	Creates a new XmlReader instance by using the specified text reader and settings. More...

static SharedPtr< XmlReader >	Create (const SharedPtr< IO::TextReader > &input, SharedPtr< XmlReaderSettings > settings, const String &baseUri)
	Creates a new XmlReader instance by using the specified text reader, settings, and base URI. More...

static SharedPtr< XmlReader >	Create (const SharedPtr< IO::TextReader > &input, SharedPtr< XmlReaderSettings > settings, const SharedPtr< XmlParserContext > &inputContext)
	Creates a new XmlReader instance by using the specified text reader, settings, and context information for parsing. More...

static SharedPtr< XmlReader >	Create (const SharedPtr< XmlReader > &reader, SharedPtr< XmlReaderSettings > settings)
	Creates a new XmlReader instance by using the specified XML reader and settings. 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
virtual void	Dispose (bool disposing)
	Optionally releases all resources used by the current instance of the XmlReader class. More...

virtual	~XmlReader ()

Detailed Description

Represents a reader that provides fast, noncached, forward-only access to XML data.

Member Typedef Documentation

◆ Ptr

using System::Xml::XmlReader::Ptr = SharedPtr<XmlReader>

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

Constructor & Destructor Documentation

◆ ~XmlReader()

virtual System::Xml::XmlReader::~XmlReader ( )

protectedvirtual

Member Function Documentation

◆ Close()

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

virtual

When overridden in a derived class, changes the XmlReader::get_ReadState to ReadState::Closed.

Reimplemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ Create() [1/12]

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

static

Creates a new XmlReader instance using the specified stream with default settings.

Parameters

input The stream that contains the XML data. The XmlReader scans the first bytes of the stream looking for a byte order mark or other sign of encoding. When encoding is determined, the encoding is used to continue reading the stream, and processing continues parsing the input as a stream of (Unicode) characters.

Returns: An object that is used to read the XML data in the stream.

Exceptions

ArgumentNullException	The `input` value is `nullptr`.
SecurityException	The XmlReader does not have sufficient permissions to access the location of the XML data.

◆ Create() [2/12]

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

static

Creates a new XmlReader instance with the specified stream and settings.

Parameters

input	The stream that contains the XML data. The XmlReader scans the first bytes of the stream looking for a byte order mark or other sign of encoding. When encoding is determined, the encoding is used to continue reading the stream, and processing continues parsing the input as a stream of (Unicode) characters.
settings	The settings for the new XmlReader instance. This value can be `nullptr`.

Returns: An object that is used to read the XML data in the stream.

Exceptions

ArgumentNullException The input value is nullptr.

◆ Create() [3/12]

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

static

Creates a new XmlReader instance using the specified stream, settings, and context information for parsing.

Parameters

input	The stream that contains the XML data. The XmlReader scans the first bytes of the stream looking for a byte order mark or other sign of encoding. When encoding is determined, the encoding is used to continue reading the stream, and processing continues parsing the input as a stream of (Unicode) characters.
settings	The settings for the new XmlReader instance. This value can be `nullptr`.
inputContext	The context information required to parse the XML fragment. The context information can include the XmlNameTable to use, encoding, namespace scope, the current `xml:lang` and `xml:space` scope, base URI, and document type definition. This value can be `nullptr`.

Returns: An object that is used to read the XML data in the stream.

Exceptions

ArgumentNullException The input value is nullptr.

◆ Create() [4/12]

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

static

Creates a new XmlReader instance using the specified stream, base URI, and settings.

Parameters

input	The stream that contains the XML data. The XmlReader scans the first bytes of the stream looking for a byte order mark or other sign of encoding. When encoding is determined, the encoding is used to continue reading the stream, and processing continues parsing the input as a stream of (Unicode) characters.
settings	The settings for the new XmlReader instance. This value can be `nullptr`.
baseUri	The base URI for the entity or document being read. This value can be `nullptr`. Security Note The base URI is used to resolve the relative URI of the XML document. Do not use a base URI from an untrusted source.

Returns: An object that is used to read the XML data in the stream.

Exceptions

ArgumentNullException The input value is nullptr.

◆ Create() [5/12]

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

static

Creates a new XmlReader instance by using the specified text reader.

Parameters

input The text reader from which to read the XML data. A text reader returns a stream of Unicode characters, so the encoding specified in the XML declaration is not used by the XML reader to decode the data stream.

Returns: An object that is used to read the XML data in the stream.

Exceptions

ArgumentNullException The input value is nullptr.

◆ Create() [6/12]

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

static

Creates a new XmlReader instance by using the specified text reader and settings.

Parameters

input	The text reader from which to read the XML data. A text reader returns a stream of Unicode characters, so the encoding specified in the XML declaration isn't used by the XML reader to decode the data stream.
settings	The settings for the new XmlReader. This value can be `nullptr`.

Returns: An object that is used to read the XML data in the stream.

Exceptions

ArgumentNullException The input value is nullptr.

◆ Create() [7/12]

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

static

Creates a new XmlReader instance by using the specified text reader, settings, and context information for parsing.

Parameters

input	The text reader from which to read the XML data. A text reader returns a stream of Unicode characters, so the encoding specified in the XML declaration isn't used by the XML reader to decode the data stream.
settings	The settings for the new XmlReader instance. This value can be `nullptr`.
inputContext	The context information required to parse the XML fragment. The context information can include the XmlNameTable to use, encoding, namespace scope, the current `xml:lang` and `xml:space` scope, base URI, and document type definition. This value can be `nullptr`.

Returns: An object that is used to read the XML data in the stream.

Exceptions

ArgumentNullException	The `input` value is `nullptr`.
ArgumentException	The XmlReaderSettings::get_NameTable and XmlParserContext::get_NameTable both are non-nullptr values. (Only one of these `NameTable` values can be set and used).

◆ Create() [8/12]

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

static

Creates a new XmlReader instance by using the specified text reader, settings, and base URI.

Parameters

input	The text reader from which to read the XML data. A text reader returns a stream of Unicode characters, so the encoding specified in the XML declaration isn't used by the XmlReader to decode the data stream.
settings	The settings for the new XmlReader instance. This value can be `nullptr`.
baseUri	The base URI for the entity or document being read. This value can be `nullptr`. Security Note The base URI is used to resolve the relative URI of the XML document. Do not use a base URI from an untrusted source.

Returns: An object that is used to read the XML data in the stream.

Exceptions

ArgumentNullException The input value is nullptr.

◆ Create() [9/12]

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

static

Creates a new XmlReader instance by using the specified XML reader and settings.

Parameters

reader	The object that you want to use as the underlying XML reader.
settings	The settings for the new XmlReader instance. The conformance level of the XmlReaderSettings object must either match the conformance level of the underlying reader, or it must be set to ConformanceLevel::Auto.

Returns: An object that is wrapped around the specified XmlReader object.

Exceptions

ArgumentNullException	The `reader` value is `nullptr`.
InvalidOperationException	If the XmlReaderSettings object specifies a conformance level that is not consistent with conformance level of the underlying reader. The underlying XmlReader is in an ReadState::Error or ReadState::Closed state.

◆ Create() [10/12]

static SharedPtr< XmlReader > System::Xml::XmlReader::Create ( const String & inputUri )

static

Creates a new XmlReader instance with specified URI.

Parameters

inputUri The URI for the file that contains the XML data. The XmlUrlResolver class is used to convert the path to a canonical data representation.

Returns: An object that is used to read the XML data in the stream.

Exceptions

ArgumentNullException	The `inputUri` value is `nullptr`.
SecurityException	The XmlReader does not have sufficient permissions to access the location of the XML data.
FileNotFoundException	The file identified by the URI does not exist.
UriFormatException	The URI format is not correct.

◆ Create() [11/12]

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

static

Creates a new XmlReader instance by using the specified URI and settings.

Parameters

inputUri	The URI for the file containing the XML data. The XmlResolver object on the XmlReaderSettings object is used to convert the path to a canonical data representation. If XmlReaderSettings::get_XmlResolver value is `nullptr`, a new XmlUrlResolver object is used.
settings	The settings for the new XmlReader instance. This value can be `nullptr`.

Returns: An object that is used to read the XML data in the stream.

Exceptions

ArgumentNullException	The `inputUri` value is `nullptr`.
FileNotFoundException	The file specified by the URI cannot be found.
UriFormatException	The URI format is not correct.

◆ Create() [12/12]

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

static

Creates a new XmlReader instance by using the specified URI, settings, and context information for parsing.

Parameters

inputUri	The URI for the file containing the XML data. The XmlResolver object on the XmlReaderSettings object is used to convert the path to a canonical data representation. If XmlReaderSettings::get_XmlResolver value is `nullptr`, a new XmlUrlResolver object is used.
settings	The settings for the new XmlReader instance. This value can be `nullptr`.
inputContext	The context information required to parse the XML fragment. The context information can include the XmlNameTable to use, encoding, namespace scope, the current `xml:lang` and `xml:space` scope, base URI, and document type definition. This value can be `nullptr`.

Returns: An object that is used to read the XML data in the stream.

Exceptions

ArgumentNullException	The `inputUri` value is `nullptr`.
SecurityException	The XmlReader does not have sufficient permissions to access the location of the XML data.
ArgumentException	The XmlReaderSettings::get_NameTable and XmlParserContext::get_NameTable both are non-nullptr values. (Only one of these `NameTable` values can be set and used).
FileNotFoundException	The file specified by the URI cannot be found.
UriFormatException	The URI format is not correct.

◆ Dispose() [1/2]

void System::Xml::XmlReader::Dispose ( )

overridevirtual

Releases all resources used by the current instance of the XmlReader class.

Reimplemented from System::IDisposable.

◆ Dispose() [2/2]

virtual void System::Xml::XmlReader::Dispose ( bool disposing )

protectedvirtual

Optionally releases all resources used by the current instance of the XmlReader class.

Parameters

disposing true to release the resources; false to do nothing.

◆ get_AttributeCount()

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

pure virtual

When overridden in a derived class, gets the number of attributes on the current node.

Returns: The number of attributes on the current node.

Implemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ get_BaseURI()

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

pure virtual

When overridden in a derived class, gets the base URI of the current node.

Returns: The base URI of the current node.

Implemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ get_CanReadBinaryContent()

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

virtual

Returns a value indicating whether the XmlReader implements the binary content read methods.

Returns: true if the binary content read methods are implemented; otherwise false.

Reimplemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ get_CanReadValueChunk()

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

virtual

Returns a value indicating whether the XmlReader implements the XmlReader::ReadValueChunk method.

Returns: true if the XmlReader implements the XmlReader::ReadValueChunk method; otherwise false.

Reimplemented in System::Xml::XmlTextReader.

◆ get_CanResolveEntity()

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

virtual

Returns a value indicating whether this reader can parse and resolve entities.

Returns: true if the reader can parse and resolve entities; otherwise, false.

Reimplemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ get_Depth()

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

pure virtual

When overridden in a derived class, gets the depth of the current node in the XML document.

Returns: The depth of the current node in the XML document.

Implemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ get_EOF()

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

pure virtual

When overridden in a derived class, gets a value indicating whether the reader is positioned at the end of the stream.

Returns: true if the reader is positioned at the end of the stream; otherwise, false.

Implemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ get_HasAttributes()

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

virtual

Returns a value indicating whether the current node has any attributes.

Returns: true if the current node has attributes; otherwise, false.

Reimplemented in System::Xml::XmlNodeReader.

◆ get_HasValue()

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

virtual

When overridden in a derived class, gets a value indicating whether the current node can have a XmlReader::get_Value value.

Returns: true if the node on which the reader is currently positioned can have a Value; otherwise, false. If false, the node has a value of String::Empty.

Reimplemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ get_IsDefault()

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

virtual

When overridden in a derived class, gets a value indicating whether the current node is an attribute that was generated from the default value defined in the DTD or schema.

Returns: true if the current node is an attribute whose value was generated from the default value defined in the DTD or schema; false if the attribute value was explicitly set.

Reimplemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ get_IsEmptyElement()

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

pure virtual

When overridden in a derived class, gets a value indicating whether the current node is an empty element (for example, <MyElement/>).

Returns: true if the current node is an element (XmlReader::get_NodeType equals XmlNodeType::Element) that ends with />; otherwise, false.

Implemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ get_LocalName()

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

pure virtual

When overridden in a derived class, gets the local name of the current node.

Returns: The name of the current node with the prefix removed. For example, LocalName is book for the element <bk:book>. For node types that do not have a name (like Text, Comment, and so on), this method returns String::Empty.

Implemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ get_Name()

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

virtual

When overridden in a derived class, gets the qualified name of the current node.

Returns: The qualified name of the current node. For example, Name is bk:book for the element <bk:book>.

The name returned is dependent on the XmlReader::get_NodeType value of the node. The following node types return the listed values. All other node types return an empty string.

Node type	Name
`Attribute`	The name of the attribute.
`DocumentType`	The document type name.
`Element`	The tag name.
`EntityReference`	The name of the entity referenced.
`ProcessingInstruction`	The target of the processing instruction.
XmlDeclaration	The literal string `xml`.

Reimplemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ get_NamespaceURI()

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

pure virtual

When overridden in a derived class, gets the namespace URI (as defined in the W3C Namespace specification) of the node on which the reader is positioned.

Returns: The namespace URI of the current node; otherwise an empty string.

Implemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ get_NameTable()

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

pure virtual

When overridden in a derived class, gets the XmlNameTable associated with this implementation.

Returns: The XmlNameTable enabling you to get the atomized version of a string within the node.

Implemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ get_NodeType()

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

pure virtual

When overridden in a derived class, gets the type of the current node.

Returns: One of the enumeration values that specify the type of the current node.

Implemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ get_Prefix()

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

pure virtual

When overridden in a derived class, gets the namespace prefix associated with the current node.

Returns: The namespace prefix associated with the current node.

Implemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ get_QuoteChar()

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

virtual

When overridden in a derived class, gets the quotation mark character used to enclose the value of an attribute node.

Returns: The quotation mark character (" or ') used to enclose the value of an attribute node.

Reimplemented in System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ get_ReadState()

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

pure virtual

When overridden in a derived class, gets the state of the reader.

Returns: One of the enumeration values that specifies the state of the reader.

Implemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ get_SchemaInfo()

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

virtual

Returns the schema information that has been assigned to the current node as a result of schema validation.

Returns: An IXmlSchemaInfo object containing the schema information for the current node. Schema information can be set on elements, attributes, or on text nodes with a non-null XmlReader::get_ValueType value. If the current node is not one of the above node types, or if the XmlReader instance does not report schema information, this method returns nullptr. If this method is called from an XmlTextReader or an XmlValidatingReader object, this method always returns nullptr. These XmlReader implementations do not expose schema information through the get_SchemaInfo method.

Reimplemented in System::Xml::XmlNodeReader.

◆ get_Settings()

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

virtual

Returns the XmlReaderSettings object used to create this XmlReader instance.

Returns: The XmlReaderSettings object used to create this reader instance. If this reader was not created using the XmlReader::Create method, this method returns nullptr.

◆ get_Value()

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

pure virtual

When overridden in a derived class, gets the text value of the current node.

Returns: The value returned depends on the XmlReader::get_NodeType value of the node.

The following table lists node types that have a value to return. All other node types return String::Empty.

Node type	Value
`Attribute`	The value of the attribute.
`CDATA`	The content of the CDATA section.
`Comment`	The content of the comment.
`DocumentType`	The internal subset.
`ProcessingInstruction`	The entire content, excluding the target.
`SignificantWhitespace`	The white space between markup in a mixed content model.
`Text`	The content of the text node.
`Whitespace`	The white space between markup.
XmlDeclaration	The content of the declaration.

Implemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ get_ValueType()

virtual TypeInfo System::Xml::XmlReader::get_ValueType ( )

virtual

Returns The type for the current node.

Returns: The type that corresponds to the typed value of the node. The default is String.

◆ get_XmlLang()

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

virtual

When overridden in a derived class, gets the current xml:lang scope.

Returns: The current xml:lang scope.

Reimplemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ get_XmlSpace()

virtual System::Xml::XmlSpace System::Xml::XmlReader::get_XmlSpace ( )

virtual

When overridden in a derived class, gets the current xml:space scope.

Returns: One of the XmlSpace values. If no xml:space scope exists, this value defaults to XmlSpace::None.

Reimplemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ GetAttribute() [1/3]

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

pure virtual

When overridden in a derived class, gets the value of the attribute with the specified index.

Parameters

i	The index of the attribute. The index is zero-based. (The first attribute has index 0.)

Returns: The value of the specified attribute. This method does not move the reader.

Exceptions

ArgumentOutOfRangeException i is out of range. It must be non-negative and less than the size of the attribute collection.

Implemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ GetAttribute() [2/3]

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

pure virtual

When overridden in a derived class, gets the value of the attribute with the specified XmlReader::get_Name value.

Parameters

name	The qualified name of the attribute.

Returns: The value of the specified attribute. If the attribute is not found or the value is String::Empty, nullptr is returned.

Exceptions

ArgumentNullException name is nullptr.

Implemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ GetAttribute() [3/3]

virtual String System::Xml::XmlReader::GetAttribute	(	String	name,
		String	namespaceURI
	)

pure virtual

When overridden in a derived class, gets the value of the attribute with the specified XmlReader::get_LocalName and XmlReader::get_NamespaceURI values.

Parameters

name	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 or the value is String::Empty, nullptr is returned. This method does not move the reader.

Exceptions

ArgumentNullException name is nullptr.

Implemented in System::Xml::XmlTextReader, System::Xml::XmlValidatingReader, and System::Xml::XmlNodeReader.

◆ idx_get() [1/3]

virtual String System::Xml::XmlReader::idx_get ( int32_t i )

virtual

When overridden in a derived class, gets the value of the attribute with the specified index.

Parameters

i	The index of the attribute.

Returns: The value of the specified attribute.

◆ idx_get() [2/3]

virtual String System::Xml::XmlReader::idx_get ( String name )

virtual

When overridden in a derived class, gets the value of the attribute with the specified XmlReader::get_Name value.

Parameters

name	The qualified name of the attribute.

Returns: The value of the specified attribute. If the attribute is not found, nullptr is returned.

◆ idx_get() [3/3]

virtual String System::Xml::XmlReader::idx_get	(	String	name,
		String	namespaceURI
	)

virtual

When overridden in a derived class, gets the value of the attribute with the specified XmlReader::get_LocalName and XmlReader::get_NamespaceURI values.

Parameters

name	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, nullptr is returned.

◆ IsName()

static bool System::Xml::XmlReader::IsName ( const String & str )

static

Returns a value indicating whether the string argument is a valid XML name.

Parameters

str	The name to validate.

Returns: true if the name is valid; otherwise, false.

Exceptions

ArgumentNullException The str value is nullptr.

◆ IsNameToken()

static bool System::Xml::XmlReader::IsNameToken ( const String & str )

static

Returns a value indicating whether or not the string argument is a valid XML name token.

Parameters

str	The name token to validate.

Returns: true if it is a valid name token; otherwise false.

Exceptions

ArgumentNullException The str value is nullptr.

◆ IsStartElement() [1/3]

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

virtual

Calls XmlReader::MoveToContent and tests if the current content node is a start tag or empty element tag.

Returns: true if XmlReader::MoveToContent finds a start tag or empty element tag; false if a node type other than XmlNodeType::Element was found.

Exceptions

XmlException Incorrect XML is encountered in the input stream.

◆ IsStartElement() [2/3]

virtual bool System::Xml::XmlReader::IsStartElement	(	String	localname,
		String	ns
	)

virtual

Calls XmlReader::MoveToContent and tests if the current content node is a start tag or empty element tag and if the XmlReader::get_LocalName and XmlReader::get_NamespaceURI values of the element found match the given strings.

Parameters

localname	The string to match against the `LocalName` value of the element found.
ns	The string to match against the `NamespaceURI` value of the element found.

Returns: true if the resulting node is an element. false if a node type other than XmlNodeType::Element was found or if the LocalName and NamespaceURI values of the element do not match the specified strings.

Exceptions

XmlException Incorrect XML is encountered in the input stream.

◆ IsStartElement() [3/3]

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

virtual

Calls XmlReader::MoveToContent and tests if the current content node is a start tag or empty element tag and if the XmlReader::get_Name value of the element found matches the given argument.

Parameters

name	The string matched against the `Name` value of the element found.

Returns: true if the resulting node is an element and the Name value matches the specified string. false if a node type other than XmlNodeType::Element was found or if the element Name value does not match the specified string.

Exceptions

XmlException Incorrect XML is encountered in the input stream.

◆ LookupNamespace()

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

pure virtual

When overridden in a derived class, resolves a namespace prefix in the current element's scope.

Parameters

prefix The prefix whose namespace URI you want to resolve. To match the default namespace, pass an empty string.

Returns: The namespace URI to which the prefix maps or nullptr if no matching prefix is found.

Implemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ MoveToAttribute() [1/3]

virtual void System::Xml::XmlReader::MoveToAttribute ( int32_t i )

virtual

When overridden in a derived class, moves to the attribute with the specified index.

Parameters

i	The index of the attribute.

Exceptions

ArgumentOutOfRangeException The parameter has a negative value.

Reimplemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ MoveToAttribute() [2/3]

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

pure virtual

When overridden in a derived class, moves to the attribute with the specified XmlReader::get_Name value.

Parameters

name	The qualified name of the attribute.

Returns: true if the attribute is found; otherwise, false. If false, the reader's position does not change.

Exceptions

ArgumentException The parameter is an empty string.

Implemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ MoveToAttribute() [3/3]

virtual bool System::Xml::XmlReader::MoveToAttribute	(	String	name,
		String	ns
	)

pure virtual

When overridden in a derived class, moves to the attribute with the specified XmlReader::get_LocalName and XmlReader::get_NamespaceURI values.

Parameters

name	The local name of the attribute.
ns	The namespace URI of the attribute.

Returns: true if the attribute is found; otherwise, false. If false, the reader's position does not change.

Exceptions

ArgumentNullException Both parameter values are nullptr.

Implemented in System::Xml::XmlTextReader, System::Xml::XmlValidatingReader, and System::Xml::XmlNodeReader.

◆ MoveToContent()

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

virtual

Checks whether the current node is a content (non-white space text, CDATA, Element, EndElement, EntityReference, or EndEntity) node. If the node is not a content node, the reader skips ahead to the next content node or end of file. It skips over nodes of the following type: ProcessingInstruction, DocumentType, Comment, Whitespace, or SignificantWhitespace.

Returns: The XmlReader::get_NodeType value of the current node found by the method or XmlNodeType::None if the reader has reached the end of the input stream.

Exceptions

XmlException Incorrect XML encountered in the input stream.

◆ MoveToElement()

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

pure virtual

When overridden in a derived class, moves to the element that contains the current attribute node.

Returns: true if the reader is positioned on an attribute (the reader moves to the element that owns the attribute); false if the reader is not positioned on an attribute (the position of the reader does not change).

Implemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ MoveToFirstAttribute()

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

pure virtual

When overridden in a derived class, moves to the first attribute.

Returns: true if an attribute exists (the reader moves to the first attribute); otherwise, false (the position of the reader does not change).

Implemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ MoveToNextAttribute()

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

pure virtual

When overridden in a derived class, moves to the next attribute.

Returns: true if there is a next attribute; false if there are no more attributes.

Implemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ Read()

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

pure virtual

When overridden in a derived class, reads the next node from the stream.

Returns: true if the next node was read successfully; otherwise, false.

Exceptions

XmlException An error occurred while parsing the XML.

Implemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ ReadAttributeValue()

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

pure virtual

When overridden in a derived class, parses the attribute value into one or more Text, EntityReference, or EndEntity nodes.

Returns: true if there are nodes to return. false if the reader is not positioned on an attribute node when the initial call is made or if all the attribute values have been read. An empty attribute, such as, misc="", returns true with a single node with a value of String::Empty.

Implemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ ReadContentAs()

virtual SharedPtr< Object > System::Xml::XmlReader::ReadContentAs	(	const TypeInfo &	returnType,
		SharedPtr< IXmlNamespaceResolver >	namespaceResolver
	)

virtual

Reads the content as an object of the type specified.

Parameters

returnType	The type of the value to be returned.
namespaceResolver	An IXmlNamespaceResolver object that is used to resolve any namespace prefixes related to type conversion. For example, this can be used when converting an XmlQualifiedName object to an `xs:string`. This value can be `nullptr`.

Returns: The concatenated text content or attribute value converted to the requested type.

Exceptions

FormatException	The content is not in the correct format for the target type.
InvalidCastException	The attempted cast is not valid.
ArgumentNullException	The `returnType` value is `nullptr`.
InvalidOperationException	The current node is not a supported node type.
OverflowException	Read Decimal::MaxValue.

◆ ReadContentAsBase64()

virtual int32_t System::Xml::XmlReader::ReadContentAsBase64	(	ArrayPtr< uint8_t >	buffer,
		int32_t	index,
		int32_t	count
	)

virtual

Reads the content and returns the Base64 decoded binary bytes.

Parameters

buffer	The buffer into which to copy the resulting text. This value cannot be `nullptr`.
index	The offset into the buffer where to start copying the result.
count	The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.

Returns: The number of bytes written to the buffer.

Exceptions

ArgumentNullException	The `buffer` value is `nullptr`.
InvalidOperationException	The call is not supported on the current node.
ArgumentOutOfRangeException	The index into the buffer or index + count is larger than the allocated buffer size.
NotSupportedException	The XmlReader implementation does not support this method.

Reimplemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ ReadContentAsBinHex()

virtual int32_t System::Xml::XmlReader::ReadContentAsBinHex	(	ArrayPtr< uint8_t >	buffer,
		int32_t	index,
		int32_t	count
	)

virtual

Reads the content and returns the BinHex decoded binary bytes.

Parameters

buffer	The buffer into which to copy the resulting text. This value cannot be `nullptr`.
index	The offset into the buffer where to start copying the result.
count	The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.

Returns: The number of bytes written to the buffer.

Exceptions

ArgumentNullException	The `buffer` value is `nullptr`.
InvalidOperationException	The call is not supported on the current node.
ArgumentOutOfRangeException	The index into the buffer or index + count is larger than the allocated buffer size.
NotSupportedException	The XmlReader implementation does not support this method.

Reimplemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ ReadContentAsBoolean()

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

virtual

Reads the text content at the current position as a Boolean.

Returns: The text content as a Boolean object.

Exceptions

InvalidCastException	The attempted cast is not valid.
FormatException	The string format is not valid.

◆ ReadContentAsDateTime()

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

virtual

Reads the text content at the current position as a DateTime object.

Returns: The text content as a DateTime object.

Exceptions

InvalidCastException	The attempted cast is not valid.
FormatException	The string format is not valid.

◆ ReadContentAsDateTimeOffset()

virtual DateTimeOffset System::Xml::XmlReader::ReadContentAsDateTimeOffset ( )

virtual

Reads the text content at the current position as a DateTimeOffset object.

Returns: The text content as a DateTimeOffset object.

◆ ReadContentAsDecimal()

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

virtual

Reads the text content at the current position as a Decimal object.

Returns: The text content at the current position as a Decimal object.

Exceptions

InvalidCastException	The attempted cast is not valid.
FormatException	The string format is not valid.

◆ ReadContentAsDouble()

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

virtual

Reads the text content at the current position as a double-precision floating-point number.

Returns: The text content as a double-precision floating-point number.

Exceptions

InvalidCastException	The attempted cast is not valid.
FormatException	The string format is not valid.

◆ ReadContentAsFloat()

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

virtual

Reads the text content at the current position as a single-precision floating point number.

Returns: The text content at the current position as a single-precision floating point number.

Exceptions

InvalidCastException	The attempted cast is not valid.
FormatException	The string format is not valid.

◆ ReadContentAsInt()

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

virtual

Reads the text content at the current position as a 32-bit signed integer.

Returns: The text content as a 32-bit signed integer.

Exceptions

InvalidCastException	The attempted cast is not valid.
FormatException	The string format is not valid.

◆ ReadContentAsLong()

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

virtual

Reads the text content at the current position as a 64-bit signed integer.

Returns: The text content as a 64-bit signed integer.

Exceptions

InvalidCastException	The attempted cast is not valid.
FormatException	The string format is not valid.

◆ ReadContentAsObject()

virtual SharedPtr< Object > System::Xml::XmlReader::ReadContentAsObject ( )

virtual

Reads the text content at the current position as an Object.

Returns: The text content as the most appropriate object type.

Exceptions

InvalidCastException	The attempted cast is not valid.
FormatException	The string format is not valid.

◆ ReadContentAsString()

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

virtual

Reads the text content at the current position as a String object.

Returns: The text content as a String object.

Exceptions

InvalidCastException	The attempted cast is not valid.
FormatException	The string format is not valid.

◆ ReadElementContentAs() [1/2]

virtual SharedPtr< Object > System::Xml::XmlReader::ReadElementContentAs	(	const TypeInfo &	returnType,
		SharedPtr< IXmlNamespaceResolver >	namespaceResolver
	)

virtual

Reads the element content as the requested type.

Parameters

returnType	The type of the value to be returned.
namespaceResolver	An IXmlNamespaceResolver object that is used to resolve any namespace prefixes related to type conversion.

Returns: The element content converted to the requested typed object.

Exceptions

InvalidOperationException	The XmlReader is not positioned on an element.
XmlException	The current element contains child elements. The element content cannot be converted to the requested type.
ArgumentNullException	The method is called with `nullptr` arguments.
OverflowException	Read Decimal::MaxValue.

◆ ReadElementContentAs() [2/2]

virtual SharedPtr< Object > System::Xml::XmlReader::ReadElementContentAs	(	const TypeInfo &	returnType,
		SharedPtr< IXmlNamespaceResolver >	namespaceResolver,
		String	localName,
		String	namespaceURI
	)

virtual

Checks that the specified local name and namespace URI matches that of the current element, then reads the element content as the requested type.

Parameters

returnType	The type of the value to be returned.
namespaceResolver	An IXmlNamespaceResolver object that is used to resolve any namespace prefixes related to type conversion.
localName	The local name of the element.
namespaceURI	The namespace URI of the element.

Returns: The element content converted to the requested typed object.

Exceptions

InvalidOperationException	The XmlReader is not positioned on an element.
XmlException	The current element contains child elements. The element content cannot be converted to the requested type.
ArgumentNullException	The method is called with `nullptr` arguments.
ArgumentException	The specified local name and namespace URI do not match that of the current element being read.
OverflowException	Read Decimal::MaxValue.

◆ ReadElementContentAsBase64()

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

virtual

Reads the element and decodes the Base64 content.

Parameters

buffer	The buffer into which to copy the resulting text. This value cannot be `nullptr`.
index	The offset into the buffer where to start copying the result.
count	The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.

Returns: The number of bytes written to the buffer.

Exceptions

ArgumentNullException	The `buffer` value is `nullptr`.
InvalidOperationException	The current node is not an element node.
ArgumentOutOfRangeException	The index into the buffer or index + count is larger than the allocated buffer size.
NotSupportedException	The XmlReader implementation does not support this method.
XmlException	The element contains mixed-content.
FormatException	The content cannot be converted to the requested type.

Reimplemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ ReadElementContentAsBinHex()

virtual int32_t System::Xml::XmlReader::ReadElementContentAsBinHex	(	ArrayPtr< uint8_t >	buffer,
		int32_t	index,
		int32_t	count
	)

virtual

Reads the element and decodes the BinHex content.

Parameters

buffer	The buffer into which to copy the resulting text. This value cannot be `nullptr`.
index	The offset into the buffer where to start copying the result.
count	The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.

Returns: The number of bytes written to the buffer.

Exceptions

ArgumentNullException	The `buffer` value is `nullptr`.
InvalidOperationException	The current node is not an element node.
ArgumentOutOfRangeException	The index into the buffer or index + count is larger than the allocated buffer size.
NotSupportedException	The XmlReader implementation does not support this method.
XmlException	The element contains mixed-content.
FormatException	The content cannot be converted to the requested type.

Reimplemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ ReadElementContentAsBoolean() [1/2]

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

virtual

Reads the current element and returns the contents as a Boolean object.

Returns: The element content as a Boolean object.

Exceptions

InvalidOperationException	The XmlReader is not positioned on an element.
XmlException	The current element contains child elements. The element content cannot be converted to a Boolean object.
ArgumentNullException	The method is called with `nullptr` arguments.

◆ ReadElementContentAsBoolean() [2/2]

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

virtual

Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a Boolean object.

Parameters

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

Returns: The element content as a Boolean object.

Exceptions

InvalidOperationException	The XmlReader is not positioned on an element.
XmlException	The current element contains child elements. The element content cannot be converted to the requested type.
ArgumentNullException	The method is called with `nullptr` arguments.
ArgumentException	The specified local name and namespace URI do not match that of the current element being read.

◆ ReadElementContentAsDateTime() [1/2]

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

virtual

Reads the current element and returns the contents as a DateTime object.

Returns: The element content as a DateTime object.

Exceptions

InvalidOperationException	The XmlReader is not positioned on an element.
XmlException	The current element contains child elements. The element content cannot be converted to a DateTime object.
ArgumentNullException	The method is called with `nullptr` arguments.

◆ ReadElementContentAsDateTime() [2/2]

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

virtual

Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a DateTime object.

Parameters

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

Returns: The element contents as a DateTime object.

Exceptions

InvalidOperationException	The XmlReader is not positioned on an element.
XmlException	The current element contains child elements. The element content cannot be converted to the requested type.
ArgumentNullException	The method is called with `nullptr` arguments.
ArgumentException	The specified local name and namespace URI do not match that of the current element being read.

◆ ReadElementContentAsDecimal() [1/2]

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

virtual

Reads the current element and returns the contents as a Decimal object.

Returns: The element content as a Decimal object.

Exceptions

InvalidOperationException	The XmlReader is not positioned on an element.
XmlException	The current element contains child elements. The element content cannot be converted to a Decimal.
ArgumentNullException	The method is called with `nullptr` arguments.

◆ ReadElementContentAsDecimal() [2/2]

virtual Decimal System::Xml::XmlReader::ReadElementContentAsDecimal	(	String	localName,
		String	namespaceURI
	)

virtual

Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a Decimal object.

Parameters

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

Returns: The element content as a Decimal object.

Exceptions

InvalidOperationException	The XmlReader is not positioned on an element.
XmlException	The current element contains child elements. The element content cannot be converted to a Decimal.
ArgumentNullException	The method is called with `nullptr` arguments.
ArgumentException	The specified local name and namespace URI do not match that of the current element being read.

◆ ReadElementContentAsDouble() [1/2]

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

virtual

Reads the current element and returns the contents as a double-precision floating-point number.

Returns: The element content as a double-precision floating-point number.

Exceptions

InvalidOperationException	The XmlReader is not positioned on an element.
XmlException	The current element contains child elements. The element content cannot be converted to a double-precision floating-point number.
ArgumentNullException	The method is called with `nullptr` arguments.

◆ ReadElementContentAsDouble() [2/2]

virtual double System::Xml::XmlReader::ReadElementContentAsDouble	(	String	localName,
		String	namespaceURI
	)

virtual

Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a double-precision floating-point number.

Parameters

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

Returns: The element content as a double-precision floating-point number.

Exceptions

InvalidOperationException	The XmlReader is not positioned on an element.
XmlException	The current element contains child elements. The element content cannot be converted to the requested type.
ArgumentNullException	The method is called with `nullptr` arguments.
ArgumentException	The specified local name and namespace URI do not match that of the current element being read.

◆ ReadElementContentAsFloat() [1/2]

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

virtual

Reads the current element and returns the contents as single-precision floating-point number.

Returns: The element content as a single-precision floating point number.

Exceptions

InvalidOperationException	The XmlReader is not positioned on an element.
XmlException	The current element contains child elements. The element content cannot be converted to a single-precision floating-point number.
ArgumentNullException	The method is called with `nullptr` arguments.

◆ ReadElementContentAsFloat() [2/2]

virtual float System::Xml::XmlReader::ReadElementContentAsFloat	(	String	localName,
		String	namespaceURI
	)

virtual

Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a single-precision floating-point number.

Parameters

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

Returns: The element content as a single-precision floating point number.

Exceptions

InvalidOperationException	The XmlReader is not positioned on an element.
XmlException	The current element contains child elements. The element content cannot be converted to a single-precision floating-point number.
ArgumentNullException	The method is called with `nullptr` arguments.
ArgumentException	The specified local name and namespace URI do not match that of the current element being read.

◆ ReadElementContentAsInt() [1/2]

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

virtual

Reads the current element and returns the contents as a 32-bit signed integer.

Returns: The element content as a 32-bit signed integer.

Exceptions

InvalidOperationException	The XmlReader is not positioned on an element.
XmlException	The current element contains child elements. The element content cannot be converted to a 32-bit signed integer.

◆ ReadElementContentAsInt() [2/2]

virtual int32_t System::Xml::XmlReader::ReadElementContentAsInt	(	String	localName,
		String	namespaceURI
	)

virtual

Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a 32-bit signed integer.

Parameters

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

Returns: The element content as a 32-bit signed integer.

Exceptions

InvalidOperationException	The XmlReader is not positioned on an element.
XmlException	The current element contains child elements. The element content cannot be converted to a 32-bit signed integer.
ArgumentNullException	The method is called with `nullptr` arguments.
ArgumentException	The specified local name and namespace URI do not match that of the current element being read.

◆ ReadElementContentAsLong() [1/2]

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

virtual

Reads the current element and returns the contents as a 64-bit signed integer.

Returns: The element content as a 64-bit signed integer.

Exceptions

InvalidOperationException	The XmlReader is not positioned on an element.
XmlException	The current element contains child elements. The element content cannot be converted to a 64-bit signed integer.
ArgumentNullException	The method is called with `nullptr` arguments.

◆ ReadElementContentAsLong() [2/2]

virtual int64_t System::Xml::XmlReader::ReadElementContentAsLong	(	String	localName,
		String	namespaceURI
	)

virtual

Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a 64-bit signed integer.

Parameters

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

Returns: The element content as a 64-bit signed integer.

Exceptions

InvalidOperationException	The XmlReader is not positioned on an element.
XmlException	The current element contains child elements. The element content cannot be converted to a 64-bit signed integer.
ArgumentNullException	The method is called with `nullptr` arguments.
ArgumentException	The specified local name and namespace URI do not match that of the current element being read.

◆ ReadElementContentAsObject() [1/2]

virtual SharedPtr< Object > System::Xml::XmlReader::ReadElementContentAsObject ( )

virtual

Reads the current element and returns the contents as an Object.

Returns: A boxed object of the most appropriate type. The XmlReader::get_ValueType value determines the appropriate type. If the content is typed as a list type, this method returns an array of boxed objects of the appropriate type.

Exceptions

InvalidOperationException	The XmlReader is not positioned on an element.
XmlException	The current element contains child elements. The element content cannot be converted to the requested type
ArgumentNullException	The method is called with `nullptr` arguments.

◆ ReadElementContentAsObject() [2/2]

virtual SharedPtr< Object > System::Xml::XmlReader::ReadElementContentAsObject	(	String	localName,
		String	namespaceURI
	)

virtual

Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as an Object.

Parameters

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

Returns: A boxed object of the most appropriate type. The XmlReader::get_ValueType value determines the appropriate type. If the content is typed as a list type, this method returns an array of boxed objects of the appropriate type.

Exceptions

InvalidOperationException	The XmlReader is not positioned on an element.
XmlException	The current element contains child elements. The element content cannot be converted to the requested type.
ArgumentNullException	The method is called with `nullptr` arguments.
ArgumentException	The specified local name and namespace URI do not match that of the current element being read.

◆ ReadElementContentAsString() [1/2]

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

virtual

Reads the current element and returns the contents as a String object.

Returns: The element content as a String object.

Exceptions

InvalidOperationException	The XmlReader is not positioned on an element.
XmlException	The current element contains child elements. The element content cannot be converted to a String object.
ArgumentNullException	The method is called with `nullptr` arguments.

◆ ReadElementContentAsString() [2/2]

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

virtual

Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a String object.

Parameters

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

Returns: The element content as a String object.

Exceptions

InvalidOperationException	The XmlReader is not positioned on an element.
XmlException	The current element contains child elements. The element content cannot be converted to a String object.
ArgumentNullException	The method is called with `nullptr` arguments.
ArgumentException	The specified local name and namespace URI do not match that of the current element being read.

◆ ReadElementString() [1/3]

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

virtual

Reads a text-only element. However, it is recommended to use the XmlReader::ReadElementContentAsString method instead, because it provides a more straightforward way to handle this operation.

Returns: The text contained in the element that was read. An empty string if the element is empty.

Exceptions

XmlException The next content node is not a start tag; or the element found does not contain a simple text value.

◆ ReadElementString() [2/3]

virtual String System::Xml::XmlReader::ReadElementString	(	String	localname,
		String	ns
	)

virtual

Checks that the XmlReader::get_LocalName and XmlReader::get_NamespaceURI values of the element found matches the given strings before reading a text-only element. However, it is recommended to use the XmlReader::ReadElementContentAsString method instead, because it provides a more straightforward way to handle this operation.

Parameters

localname	The local name to check.
ns	The namespace URI to check.

Returns: The text contained in the element that was read. An empty string if the element is empty.

Exceptions

XmlException If the next content node is not a start tag; if the element LocalName or NamespaceURI values do not match the given arguments; or if the element found does not contain a simple text value.

◆ ReadElementString() [3/3]

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

virtual

Checks that the XmlReader::get_Name value of the element found matches the given string before reading a text-only element. However, it is recommended to use the XmlReader::ReadElementContentAsString method instead, because it provides a more straightforward way to handle this operation.

Parameters

name	The name to check.

Returns: The text contained in the element that was read. An empty string if the element is empty.

Exceptions

XmlException If the next content node is not a start tag; if the element Name does not match the given argument; or if the element found does not contain a simple text value.

◆ ReadEndElement()

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

virtual

Checks that the current content node is an end tag and advances the reader to the next node.

Exceptions

XmlException The current node is not an end tag or if incorrect XML is encountered in the input stream.

◆ ReadInnerXml()

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

virtual

When overridden in a derived class, reads all the content, including markup, as a string.

Returns: All the XML content, including markup, in the current node. If the current node has no children, an empty string is returned. If the current node is neither an element nor attribute, an empty string is returned.

Exceptions

XmlException The XML was not well-formed, or an error occurred while parsing the XML.

◆ ReadOuterXml()

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

virtual

When overridden in a derived class, reads the content, including markup, representing this node and all its children.

Returns: If the reader is positioned on an element or an attribute node, this method returns all the XML content, including markup, of the current node and all its children; otherwise, it returns an empty string.

Exceptions

XmlException The XML was not well-formed, or an error occurred while parsing the XML.

◆ ReadStartElement() [1/3]

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

virtual

Checks that the current node is an element and advances the reader to the next node.

Exceptions

XmlException Incorrect XML was encountered in the input stream.

◆ ReadStartElement() [2/3]

virtual void System::Xml::XmlReader::ReadStartElement	(	String	localname,
		String	ns
	)

virtual

Checks that the current content node is an element with the given XmlReader::get_LocalName and XmlReader::get_NamespaceURI values and advances the reader to the next node.

Parameters

localname	The local name of the element.
ns	The namespace URI of the element.

Exceptions

XmlException Incorrect XML was encountered in the input stream. The XmlReader::get_LocalName and XmlReader::get_NamespaceURI values of the element found do not match the given arguments.

◆ ReadStartElement() [3/3]

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

virtual

Checks that the current content node is an element with the given XmlReader::get_Name value and advances the reader to the next node.

Parameters

name	The qualified name of the element.

Exceptions

XmlException Incorrect XML was encountered in the input stream. The XmlReader::get_Name of the element does not match the given name.

◆ ReadString()

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

virtual

When overridden in a derived class, reads the contents of an element or text node as a string. However, it is recommended to use the XmlReader::ReadElementContentAsString method instead, because it provides a more straightforward way to handle this operation.

Returns: The contents of the element or an empty string.

Exceptions

XmlException An error occurred while parsing the XML.

Reimplemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ ReadSubtree()

virtual SharedPtr< XmlReader > System::Xml::XmlReader::ReadSubtree ( )

virtual

Returns a new XmlReader instance that can be used to read the current node, and all its descendants.

Returns: A new XML reader instance set to ReadState::Initial. Calling the XmlReader::Read method positions the new reader on the node that was current before the call to the XmlReader::ReadSubtree method.

Exceptions

InvalidOperationException The XML reader isn't positioned on an element when this method is called.

◆ ReadToDescendant() [1/2]

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

virtual

Advances the XmlReader to the next descendant element with the specified local name and namespace URI.

Parameters

localName	The local name of the element you wish to move to.
namespaceURI	The namespace URI of the element you wish to move to.

Returns: true if a matching descendant element is found; otherwise false. If a matching child element is not found, the XmlReader is positioned on the end tag (XmlReader::get_NodeType value is XmlNodeType::EndElement) of the element. If the XmlReader is not positioned on an element when XmlReader::ReadToDescendant(String,String) was called, this method returns false and the position of the XmlReader is not changed.

Exceptions

ArgumentNullException Both parameter values are nullptr.

◆ ReadToDescendant() [2/2]

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

virtual

Advances the XmlReader to the next descendant element with the specified qualified name.

Parameters

name	The qualified name of the element you wish to move to.

Returns: true if a matching descendant element is found; otherwise false. If a matching child element is not found, the XmlReader is positioned on the end tag (XmlReader::get_NodeType value is XmlNodeType::EndElement) of the element. If the XmlReader is not positioned on an element when XmlReader::ReadToDescendant(String) was called, this method returns false and the position of the XmlReader is not changed.

Exceptions

ArgumentException The parameter is an empty string.

◆ ReadToFollowing() [1/2]

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

virtual

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

Parameters

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

Returns: true if a matching element is found; otherwise false and the XmlReader is in an end of file state.

Exceptions

ArgumentNullException Both parameter values are nullptr.

◆ ReadToFollowing() [2/2]

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

virtual

Reads until an element with the specified qualified name is found.

Parameters

name	The qualified name of the element.

Returns: true if a matching element is found; otherwise false and the XmlReader is in an end of file state.

Exceptions

ArgumentException The parameter is an empty string.

◆ ReadToNextSibling() [1/2]

virtual bool System::Xml::XmlReader::ReadToNextSibling	(	String	localName,
		String	namespaceURI
	)

virtual

Advances the XmlReader to the next sibling element with the specified local name and namespace URI.

Parameters

localName	The local name of the sibling element you wish to move to.
namespaceURI	The namespace URI of the sibling element you wish to move to.

Returns: true if a matching sibling element is found; otherwise, false. If a matching sibling element is not found, the XmlReader is positioned on the end tag (XmlReader::get_NodeType value is XmlNodeType::EndElement) of the parent element.

Exceptions

ArgumentNullException Both parameter values are nullptr.

◆ ReadToNextSibling() [2/2]

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

virtual

Advances the XmlReader to the next sibling element with the specified qualified name.

Parameters

name	The qualified name of the sibling element you wish to move to.

Returns: true if a matching sibling element is found; otherwise false. If a matching sibling element is not found, the XmlReader is positioned on the end tag (XmlReader::get_NodeType value is XmlNodeType::EndElement) of the parent element.

Exceptions

ArgumentException The parameter is an empty string.

◆ ReadValueChunk()

virtual int32_t System::Xml::XmlReader::ReadValueChunk	(	ArrayPtr< char16_t >	buffer,
		int32_t	index,
		int32_t	count
	)

virtual

Reads large streams of text embedded in an XML document.

Parameters

buffer	The array of characters that serves as the buffer to which the text contents are written. This value cannot be `nullptr`.
index	The offset within the buffer where the XmlReader can start to copy the results.
count	The maximum number of characters to copy into the buffer. The actual number of characters copied is returned from this method.

Returns: The number of characters read into the buffer. The value zero is returned when there is no more text content.

Exceptions

InvalidOperationException	The current node does not have a value (XmlReader::get_HasValue is `false`).
ArgumentNullException	The `buffer` value is `nullptr`.
ArgumentOutOfRangeException	The index into the buffer, or index + count is larger than the allocated buffer size.
NotSupportedException	The XmlReader implementation does not support this method.
XmlException	The XML data is not well-formed.

◆ ResolveEntity()

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

pure virtual

When overridden in a derived class, resolves the entity reference for EntityReference nodes.

Exceptions

InvalidOperationException The reader is not positioned on an EntityReference node; this implementation of the reader cannot resolve entities (XmlReader::get_CanResolveEntity returns false).

Implemented in System::Xml::XmlNodeReader, System::Xml::XmlTextReader, and System::Xml::XmlValidatingReader.

◆ Skip()

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

virtual

Skips the children of the current node.

Reimplemented in System::Xml::XmlNodeReader, and System::Xml::XmlTextReader.

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ ~XmlReader()

Member Function Documentation

◆ Close()

◆ Create() [1/12]

◆ Create() [2/12]

◆ Create() [3/12]

◆ Create() [4/12]

◆ Create() [5/12]

◆ Create() [6/12]

◆ Create() [7/12]

◆ Create() [8/12]

◆ Create() [9/12]

◆ Create() [10/12]

◆ Create() [11/12]

◆ Create() [12/12]

◆ Dispose() [1/2]

◆ Dispose() [2/2]

◆ get_AttributeCount()

◆ get_BaseURI()

◆ get_CanReadBinaryContent()

◆ get_CanReadValueChunk()

◆ 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_ValueType()

◆ get_XmlLang()

◆ get_XmlSpace()

◆ GetAttribute() [1/3]

◆ GetAttribute() [2/3]

◆ GetAttribute() [3/3]

◆ idx_get() [1/3]

◆ idx_get() [2/3]

◆ idx_get() [3/3]

◆ IsName()

◆ IsNameToken()

◆ IsStartElement() [1/3]

◆ IsStartElement() [2/3]

◆ IsStartElement() [3/3]

◆ LookupNamespace()

◆ MoveToAttribute() [1/3]

◆ MoveToAttribute() [2/3]

◆ MoveToAttribute() [3/3]

◆ MoveToContent()

◆ MoveToElement()

◆ MoveToFirstAttribute()

◆ MoveToNextAttribute()

◆ Read()

◆ ReadAttributeValue()

◆ ReadContentAs()

◆ ReadContentAsBase64()

◆ ReadContentAsBinHex()

◆ ReadContentAsBoolean()

◆ ReadContentAsDateTime()

◆ ReadContentAsDateTimeOffset()

◆ ReadContentAsDecimal()

◆ ReadContentAsDouble()

◆ ReadContentAsFloat()