This topic has not yet been rated - Rate this topic

XmlReader.Create Method (Stream, XmlReaderSettings, XmlParserContext)

Creates a new XmlReader instance using the specified stream, XmlReaderSettings, and XmlParserContext objects.

Namespace:  System.Xml
Assembly:  System.Xml (in System.Xml.dll)
public static XmlReader Create(
	Stream input,
	XmlReaderSettings settings,
	XmlParserContext inputContext
)

Parameters

input
Type: System.IO.Stream

The stream containing 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
Type: System.Xml.XmlReaderSettings

The XmlReaderSettings object used to configure the new XmlReader instance. This value can be null.

inputContext
Type: System.Xml.XmlParserContext

The XmlParserContext object that provides 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 null.

Return Value

Type: System.Xml.XmlReader
An XmlReader object to read XML data.
ExceptionCondition
ArgumentNullException

The input value is null.

By default an XmlUrlResolver with no credentials is used to access any external resources such as a document type definition (DTD), entities, schemas, and so on. If the external resource is located on a network resource that requires authentication, use the XmlReaderSettings.XmlResolver property to specify an XmlResolver with the necessary credentials.

Security noteSecurity Note

You can use one of the following methods to control which resources the XmlReader can access:

Restrict the resources that the XmlReader can access by setting the XmlResolver property to an XmlSecureResolver object.

-or-

Do not allow the XmlReader to open any external resources by setting the XmlResolver property to null.

The created XmlReader object expands entity references and performs XML normalization of new line characters.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Did you find this helpful?
(1500 characters remaining)
© 2013 Microsoft. All rights reserved.