XmlTextReader.GetNamespacesInScope Method (System.Xml)

GetNamespacesInScope Method

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

XmlTextReader..::.GetNamespacesInScope Method

Gets a collection that contains all namespaces currently in-scope.

Namespace: System.Xml
Assembly: System.Xml (in System.Xml.dll)

Syntax

Visual Basic (Declaration)

Public Function GetNamespacesInScope ( _
    scope As XmlNamespaceScope _
) As IDictionary(Of String, String)

Visual Basic (Usage)

Dim instance As XmlTextReader
Dim scope As XmlNamespaceScope
Dim returnValue As IDictionary(Of String, String)

returnValue = instance.GetNamespacesInScope(scope)

public IDictionary<string, string> GetNamespacesInScope(
    XmlNamespaceScope scope
)

Visual C++

public:
IDictionary<String^, String^>^ GetNamespacesInScope(
    XmlNamespaceScope scope
)

JScript

public function GetNamespacesInScope(
    scope : XmlNamespaceScope
) : IDictionary<String, String>

Parameters

scope: Type: System.Xml..::.XmlNamespaceScope
An XmlNamespaceScope value that specifies the type of namespace nodes to return.

Return Value

Type: System.Collections.Generic..::.IDictionary<(Of <(String, String>)>)
An IDictionary object that contains all the current in-scope namespaces. If the reader is not positioned on an element, an empty dictionary (no namespaces) is returned.

Remarks

Note:
In the .NET Framework version 2.0 release, the recommended practice is to create XmlReader instances using the XmlReader..::.Create method. This allows you to take full advantage of the new features introduced in this release. For more information, see Creating XML Readers.

The dictionary consists of a collection of namespace names keyed by prefix. It can be used to enumerate the in-scope namespaces. The dictionary is a disconnected copy of the namespace list of the reader. It remains unchanged as the reader position, current in-scope namespace list, changes.

The following table describes how the XmlNamespaceScope enumeration value affects the whether or not the default and built-in namespaces are returned by GetNamespacesInScope.

XmlNamespaceScope Value	xmlns:xml	xmlns:xmlns	xmlns=""
All	yes	no	no
ExcludeXml	no	no	no
Local	no	no	yes

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Reference

XmlTextReader Class

XmlTextReader Members

System.Xml Namespace

Other Resources

Reading XML with the XmlReader