Share via


TeamFoundationCatalogService.QueryNodes Method (TeamFoundationRequestContext, IEnumerable<String>, IEnumerable<Guid>, IEnumerable<KeyValuePair<String, String>>, CatalogQueryOptions)

Returns the catalog nodes that exist below the parentPath and have a type that is listed in resourceTypeFilters.

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

Syntax

'Declaration
Public Function QueryNodes ( _
    requestContext As TeamFoundationRequestContext, _
    pathSpecs As IEnumerable(Of String), _
    resourceTypeFilters As IEnumerable(Of Guid), _
    propertyFilters As IEnumerable(Of KeyValuePair(Of String, String)), _
    queryOptions As CatalogQueryOptions _
) As List(Of CatalogNode)
public List<CatalogNode> QueryNodes(
    TeamFoundationRequestContext requestContext,
    IEnumerable<string> pathSpecs,
    IEnumerable<Guid> resourceTypeFilters,
    IEnumerable<KeyValuePair<string, string>> propertyFilters,
    CatalogQueryOptions queryOptions
)
public:
List<CatalogNode^>^ QueryNodes(
    TeamFoundationRequestContext^ requestContext, 
    IEnumerable<String^>^ pathSpecs, 
    IEnumerable<Guid>^ resourceTypeFilters, 
    IEnumerable<KeyValuePair<String^, String^>>^ propertyFilters, 
    CatalogQueryOptions queryOptions
)
member QueryNodes : 
        requestContext:TeamFoundationRequestContext * 
        pathSpecs:IEnumerable<string> * 
        resourceTypeFilters:IEnumerable<Guid> * 
        propertyFilters:IEnumerable<KeyValuePair<string, string>> * 
        queryOptions:CatalogQueryOptions -> List<CatalogNode> 
public function QueryNodes(
    requestContext : TeamFoundationRequestContext, 
    pathSpecs : IEnumerable<String>, 
    resourceTypeFilters : IEnumerable<Guid>, 
    propertyFilters : IEnumerable<KeyValuePair<String, String>>, 
    queryOptions : CatalogQueryOptions
) : List<CatalogNode>

Parameters

  • pathSpecs
    Type: System.Collections.Generic.IEnumerable<String>

    The path of the element or elements that are being searched for. This path can contain the wildcards "*", "**" and "..." where "*" means one-level and "**" and "..." means any number of levels.

  • propertyFilters
    Type: System.Collections.Generic.IEnumerable<KeyValuePair<String, String>>

    The set of property filters to apply to the nodes found. Matches will be based on both the key and the value of the property matching. If the value of a certain filter is null then it will be assumed that all nodes with the supplied property should be returned. A match consists of a node/resource that matches all of the propertyFilters.

  • queryOptions
    Type: Microsoft.TeamFoundation.Framework.Common.CatalogQueryOptions

    If ExpandDependencies is specified, the Dependencies property on nodes will contain the nodes they are dependent 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 since computing and sending information can be expensive.

Return Value

Type: System.Collections.Generic.List<CatalogNode>
The catalog nodes that exist below the parentPath and have a type that is listed in resourceTypeFilters.

.NET Framework Security

See Also

Reference

TeamFoundationCatalogService Class

QueryNodes Overload

Microsoft.TeamFoundation.Server.Core Namespace