M_CodeJam_Xml_XNodeExtensions_RequiredRoot_1

XNodeExtensions.RequiredRoot Method (XDocument, XName)

Returns document root, or throws an exception, if root is null or has another name.

Namespace: CodeJam.Xml
Assembly: CodeJam (in CodeJam.dll) Version: 2.1.0.0

Syntax

C#

public static XElement RequiredRoot(
	this XDocument document,
	XName rootName
)

VB

<ExtensionAttribute>
Public Shared Function RequiredRoot ( 
	document As XDocument,
	rootName As XName
) As XElement

F#

[<ExtensionAttribute>]
static member RequiredRoot : 
        document : XDocument * 
        rootName : XName -> XElement 

Parameters

 

document

Type: System.Xml.Linq.XDocument
The document.

rootName

Type: System.Xml.Linq.XName
Name of the root tag

Return Value

Type: XElement
Document root

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type XDocument. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

 

Exception	Condition
ArgumentNullException	document is null
XmlException	Document has no root with specified name.

See Also

Reference

XNodeExtensions Class
RequiredRoot Overload
CodeJam.Xml Namespace