CatalogWebService.QueryResourcesByType Method

Returns all of the catalog resources of the provided types.

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

Syntax

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

[WebMethodAttribute]
public CatalogData QueryResourcesByType(
    Guid[] resourceTypes,
    KeyValue<string, string>[] propertyFilters,
    int queryOptions
)

[WebMethodAttribute]
public:
CatalogData^ QueryResourcesByType(
    array<Guid>^ resourceTypes, 
    array<KeyValue<String^, String^>^>^ propertyFilters, 
    int queryOptions
)

[<WebMethodAttribute>]
member QueryResourcesByType : 
        resourceTypes:Guid[] * 
        propertyFilters:KeyValue<string, string>[] * 
        queryOptions:int -> CatalogData

public function QueryResourcesByType(
    resourceTypes : Guid[], 
    propertyFilters : KeyValue<String, String>[], 
    queryOptions : int
) : CatalogData

Parameters

• resourceTypes
  Type: array<System.Guid[]

  The identifiers for the types of resources to filter on.

• propertyFilters
  Type: array<Microsoft.TeamFoundation.Framework.Server.KeyValue<String, String>[]

  The set of property filters to apply to the resource 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 resource with the supplied property should be returned. A match consists of a 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
List of resources that exist for the specified types.

.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