CatalogWebService.QueryNodes Method

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

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

Syntax

'Declaration
<WebMethodAttribute> _
Public Function QueryNodes ( _
    pathSpecs As String(), _
    resourceTypeFilters As Guid(), _
    propertyFilters As KeyValue(Of String, String)(), _
    queryOptions As Integer _
) As CatalogData

[WebMethodAttribute]
public CatalogData QueryNodes(
    string[] pathSpecs,
    Guid[] resourceTypeFilters,
    KeyValue<string, string>[] propertyFilters,
    int queryOptions
)

[WebMethodAttribute]
public:
CatalogData^ QueryNodes(
    array<String^>^ pathSpecs, 
    array<Guid>^ resourceTypeFilters, 
    array<KeyValue<String^, String^>^>^ propertyFilters, 
    int queryOptions
)

[<WebMethodAttribute>]
member QueryNodes : 
        pathSpecs:string[] * 
        resourceTypeFilters:Guid[] * 
        propertyFilters:KeyValue<string, string>[] * 
        queryOptions:int -> CatalogData

public function QueryNodes(
    pathSpecs : String[], 
    resourceTypeFilters : Guid[], 
    propertyFilters : KeyValue<String, String>[], 
    queryOptions : int
) : CatalogData

Parameters

• pathSpecs
  Type: array<System.String[]

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

• 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.

• propertyFilters
  Type: array<Microsoft.TeamFoundation.Framework.Server.KeyValue<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 or empty 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: 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 catalog nodes that exist under the parentPath and have a type that is listed in resourceTypeFilters.

.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