ItemSpec Class

Represents one or more files or folders on the local machine or in the repository.

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.VersionControl.Client.ItemSpec

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

Syntax

'Declaration
Public NotInheritable Class ItemSpec
public sealed class ItemSpec
public ref class ItemSpec sealed
[<Sealed>]
type ItemSpec =  class end
public final class ItemSpec

The ItemSpec type exposes the following members.

Constructors

  Name Description
Public method ItemSpec(PendingChange) Initializes a new ItemSpec instance.
Public method ItemSpec(String, RecursionType) Initializes a new ItemSpec instance.
Public method ItemSpec(String, RecursionType, Int32) Initializes a new ItemSpec instance.

Top

Properties

  Name Description
Public property DeletionId Gets or sets the deletion ID of this item.
Public property Item Gets or sets the item that is associated with this ItemSpec.
Public property RecursionType Gets or sets the recursion type of this item.

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 methodStatic member FromPendingChanges Creates an array of ItemSpecs out of an array of PendingChanges.
Public methodStatic member FromStrings Gets an array of ItemSpecs from the specified array of local or server paths and a recursion level.
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 Creates a user-readable string that describes an ItemSpec object. (Overrides Object.ToString().)
Public methodStatic member ToStrings Creates an array of user-readable strings from an array of ItemSpec objects.

Top

Remarks

Must have a recursion property specified; an Item instance does not.

Path may be local or on the server. This is typically used as a paramater in methods that retrieve information (for example, QueryHistory, QueryPendingSets).

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.VersionControl.Client Namespace