ItemSpec Class

Represents one or more files or folders on the local machine or on the version-control server.

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 object.
Public property RecursionType Gets or sets the recursion type of this item. For more information about how to use this property, see Team Foundation Build activities.

Top

Methods

Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodStatic member FromPendingChanges Creates an array of ItemSpec objects out of an array of PendingChanges objects.
Public methodStatic member FromStrings Gets an array of ItemSpec objects from the specified array of local or server paths and a recursion level.
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (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 include a recursion type property, except when an ItemSpec instance is created for a pending change.

The path may be on the local machine or on the version-control server. This parameter is typically used in methods that retrieve information (for example, QueryHistory and 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