Sandcastle Help File Builder Documentation
Component
This provides a fast and efficient way of querying large XML files for specific element types which
themselves may contain instances of the given elements.
Definition
Namespace: Sandcastle.Core
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.9.12.0
An enumerable list of XElement instances for each of the found nodes including any nested instances of elements with those names.
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.9.12.0
C#
public static IEnumerable<XElement> XmlStreamAxis(
string xmlFile,
IEnumerable<string> elementNames
)VB
Public Shared Function XmlStreamAxis (
xmlFile As String,
elementNames As IEnumerable(Of String)
) As IEnumerable(Of XElement)C++
public:
static IEnumerable<XElement^>^ XmlStreamAxis(
String^ xmlFile,
IEnumerable<String^>^ elementNames
)F#
static member XmlStreamAxis :
xmlFile : string *
elementNames : IEnumerable<string> -> IEnumerable<XElement> Parameters
- xmlFile String
- The XML file to search
- elementNames IEnumerableString
- An enumerable list of element names for which to search
Return Value
IEnumerableXElementAn enumerable list of XElement instances for each of the found nodes including any nested instances of elements with those names.
Remarks
If the element contains nested instances of the elements, the parent is returned first
followed by the nested elements (one level deep only).