CatalogWebService.QueryParents Method

Returns the nodes for the resource provided, in addition to the parents.

The direct nodes and the parent nodes will not be returned if they are filtered out. For the following tree: PG1 / \ PG2 PG3 / \ \ TPC1 TPC2 TPC3 / \ TP1 TP2 Query for TP1's identifier without filters and recursing to the root would yield TP1, TPC1, PG2 and PG1.

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

Syntax

'Declaration
<WebMethodAttribute> _
Public Function QueryParents ( _
    resourceIdentifier As Guid, _
    pathFilters As String(), _
    resourceTypeFilters As Guid(), _
    recurseToRoot As Boolean, _
    queryOptions As Integer _
) As CatalogData

[WebMethodAttribute]
public CatalogData QueryParents(
    Guid resourceIdentifier,
    string[] pathFilters,
    Guid[] resourceTypeFilters,
    bool recurseToRoot,
    int queryOptions
)

[WebMethodAttribute]
public:
CatalogData^ QueryParents(
    Guid resourceIdentifier, 
    array<String^>^ pathFilters, 
    array<Guid>^ resourceTypeFilters, 
    bool recurseToRoot, 
    int queryOptions
)

[<WebMethodAttribute>]
member QueryParents : 
        resourceIdentifier:Guid * 
        pathFilters:string[] * 
        resourceTypeFilters:Guid[] * 
        recurseToRoot:bool * 
        queryOptions:int -> CatalogData

public function QueryParents(
    resourceIdentifier : Guid, 
    pathFilters : String[], 
    resourceTypeFilters : Guid[], 
    recurseToRoot : boolean, 
    queryOptions : int
) : CatalogData

Parameters

• resourceIdentifier
  Type: System.Guid

  The identifier for the resource whose parents are being queried. The resource and its nodes will only be returned if they are not filtered out

• pathFilters
  Type: array<System.String[]

  Nodes will only be returned if they live under one of the paths provided here. If this value is null or empty it will be assumed that parents from all locations in the tree are valid.

• resourceTypeFilters
  Type: array<System.Guid[]

  The list of types that this query should include. If this is null or empty, all types will be included.

• recurseToRoot
  Type: System.Boolean

  If this is true then parent nodes will be enumerated all the way to the root. If this is false then only the first level of parents will be returned.

• queryOptions
  Type: System.Int32

  If ExpandDependencies is specified, the Dependencies property on nodes will contain the nodes they depend on. If IncludeParents is specified, the ParentNode property on the CatalogNode will contain the parent node. Leaving a given option will result in the returned catalog nodes to have null for that value. Extra data should only be retrieved if it is needed, because computing and sending information can be expensive.

Return Value

Type: Microsoft.TeamFoundation.Framework.Server.CatalogData
The nodes for the resource provided in addition to the parents of those nodes that apply to the provided filters.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

CatalogWebService Class

Microsoft.TeamFoundation.Framework.Server.WebServices Namespace