This documentation is archived and is not being maintained.

ItemSpec Class

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


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

public sealed class ItemSpec

The ItemSpec type exposes the following members.

Public methodItemSpec(PendingChange)Initializes a new ItemSpec instance.
Public methodItemSpec(String, RecursionType)Initializes a new ItemSpec instance.
Public methodItemSpec(String, RecursionType, Int32)Initializes a new ItemSpec instance.

Public propertyDeletionIdGets or sets the deletion ID of this item.
Public propertyItemGets or sets the item that is associated with this ItemSpec object.
Public propertyRecursionTypeGets or sets the recursion type of this item. For more information about how to use this property, see Team Foundation Build activities.

Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodStatic memberFromPendingChangesCreates an array of ItemSpec objects out of an array of PendingChanges objects.
Public methodStatic memberFromStringsGets an array of ItemSpec objects from the specified array of local or server paths and a recursion level.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodToStringCreates a user-readable string that describes an ItemSpec object. (Overrides Object.ToString().)
Public methodStatic memberToStringsCreates an array of user-readable strings from an array of ItemSpec objects.

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

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