This documentation is archived and is not being maintained.

VersionControlServer.GetExtendedItems Method (ItemSpec[], DeletedState, ItemType)

An ExtendedItem object, unlike an item object, cannot refer to an old version of a file or project, instead, it contains detailed information about the current state of an item, both on the server that is running Team Foundation Server and in the current user's workspace. This function gets ExtendedItem objects for the specified files or folders. Branch information is not included with the getd information; you can use an overload version of this method that will allow you to request branch information.

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

public ExtendedItem[][] GetExtendedItems(
	ItemSpec[] itemSpecs,
	DeletedState deletedState,
	ItemType itemType
)

Parameters

itemSpecs
Type: Microsoft.TeamFoundation.VersionControl.Client.ItemSpec[]
deletedState
Type: Microsoft.TeamFoundation.VersionControl.Client.DeletedState

The DeletedState.NonDeleted from which you will get non-deleted items, the DeletedState.Deleted from which you will get deleted items, or the DeletedState.Any from which you will get both.

Note that the deletion ID in the ItemSpec refers to the object that you are passing in. The DeletedState refers to the objects being returned. (You could, for instance, ask for deleted files inside a non-deleted folder.)

itemType
Type: Microsoft.TeamFoundation.VersionControl.Client.ItemType

Indicates whether to return files, folders, or both.

Return Value

Type: Microsoft.TeamFoundation.VersionControl.Client.ExtendedItem[][]
Returns a jagged array of ExtendedItem objects. The first array contains all the items that correspond to the first passed ItemSpec object and continues in the same pattern. The ExtendedItem object is useful for items being changed. It contains the old and new names (which differ in the case of a branch or rename), version numbers of the current items on the server and in the workspace, and additional information. The ExtendedItem object does not contain the information necessary to download a file. This information may be included in an Item object.

For each input ItemSpec, gets a list of extended items in the database that matches the specified criteria. If the 'path' argument is a file, it returns a set of items that contain just that file. If the 'path' is a folder, then it returns a set of items that contains all items in that folder. If the 'path' contains a wildcard character, then it returns a set of items in the specified folder that matches the wildcard.

Show: