VersionControlServer.GetExtendedItems Method (String, 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. The function is not recursive, so if a folder is passed, it gets information on that folder only. 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(
	string path,
	DeletedState deletedState,
	ItemType itemType
)

Parameters

path
Type: System.String

The file or folder that you want to get. This may be a Team Foundation Server path ($/CmdLine/parse.cs) or a local path (C:\Code\CmdLine\parse.cs), in the latter case, the local path is mapped to a server path via a workspace. Wildcards are also supported.

deletedState
Type: Microsoft.TeamFoundation.VersionControl.Client.DeletedState

Indicates whether to return deleted items, non-deleted items, or both.

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

Indicates whether to return files, folders, or both.

Return Value

Type: Microsoft.TeamFoundation.VersionControl.Client.ExtendedItem[]
Returns an array of ExtendedItem objects for each getd item. This 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 other information. The ExtendedItem object does not contain the information necessary to download a file; this information may be included in an Item object.

If the path argument is a file, it returns a set of items that contain just that file. If the path is a folder, it returns a set of items that contains all items in that folder. If the path contains a wildcard character, it returns a set of items in the specified folder that matches the wildcard.

Community Additions

ADD
Show: