Share via


BatchReadParameter Class

Represents an ID and revision pair that will be added to a BatchReadParameterCollection.

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.WorkItemTracking.Client.BatchReadParameter

Namespace:  Microsoft.TeamFoundation.WorkItemTracking.Client
Assembly:  Microsoft.TeamFoundation.WorkItemTracking.Client (in Microsoft.TeamFoundation.WorkItemTracking.Client.dll)

Syntax

'Declaration
Public Class BatchReadParameter
public class BatchReadParameter
public ref class BatchReadParameter
type BatchReadParameter =  class end
public class BatchReadParameter

The BatchReadParameter type exposes the following members.

Constructors

  Name Description
Public method BatchReadParameter(Int32) Initializes a new BatchReadParameter instance.
Public method BatchReadParameter(Int32, Int32) Initializes a new BatchReadParameter instance.

Top

Properties

  Name Description
Public property Id Gets the ID of this parameter.
Public property ProjectHint Gets or sets the project hint.
Public property Revision Gets the revision of this parameter.

Top

Methods

  Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

IDs are expected to be unique in the collection. Project hints can be specified as a performance optimization to avoid extra round trips to the server. If a project hint is specified, only the relevant fields for the specified projects are paged in at first.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.TeamFoundation.WorkItemTracking.Client Namespace