ICommonStructureService.GetNodesXml Method

Gets a set of nodes as XML, including its properties and optionally its children

Namespace:  Microsoft.TeamFoundation.Server
Assembly:  Microsoft.TeamFoundation (in Microsoft.TeamFoundation.dll)

Syntax

'Declaration
Function GetNodesXml ( _
    nodeUris As String(), _
    childNodes As Boolean _
) As XmlElement
'Usage
Dim instance As ICommonStructureService 
Dim nodeUris As String()
Dim childNodes As Boolean 
Dim returnValue As XmlElement 

returnValue = instance.GetNodesXml(nodeUris, _
    childNodes)
XmlElement GetNodesXml(
    string[] nodeUris,
    bool childNodes
)
XmlElement^ GetNodesXml(
    array<String^>^ nodeUris, 
    bool childNodes
)
function GetNodesXml(
    nodeUris : String[], 
    childNodes : boolean
) : XmlElement

Parameters

  • nodeUris
    Type: array<System.String[]

    The URIs of the nodes to be obtained

  • childNodes
    Type: System.Boolean

    If True, the entire branches below the specified node are returned

Return Value

Type: System.Xml.XmlElement
An XmlElement containing the definition of the structure.

Remarks

The type, name, and ID of returned nodes are represented as Node attributes, as in the following structure:

<Nodes>

<Node Type = "NodeType" Name= "NodeName" NodeID="NodeID">

<Children\>

<Properties\>

</Node>

</Nodes>

.NET Framework Security

See Also

Reference

ICommonStructureService Interface

ICommonStructureService Members

Microsoft.TeamFoundation.Server Namespace