VersionControlServer.GetItems Method (String, VersionSpec, RecursionType, DeletedState, ItemType, Boolean)

Gets a list of all items in the repository that matches the specified path and version.

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

Syntax

'Declaration
Public Function GetItems ( _
    path As String, _
    version As VersionSpec, _
    recursion As RecursionType, _
    deletedState As DeletedState, _
    itemType As ItemType, _
    includeDownloadInfo As Boolean _
) As ItemSet

'Usage
Dim instance As VersionControlServer 
Dim path As String 
Dim version As VersionSpec 
Dim recursion As RecursionType 
Dim deletedState As DeletedState 
Dim itemType As ItemType 
Dim includeDownloadInfo As Boolean 
Dim returnValue As ItemSet 

returnValue = instance.GetItems(path, _
    version, recursion, deletedState, _
    itemType, includeDownloadInfo)

public ItemSet GetItems(
    string path,
    VersionSpec version,
    RecursionType recursion,
    DeletedState deletedState,
    ItemType itemType,
    bool includeDownloadInfo
)

public:
ItemSet^ GetItems(
    String^ path, 
    VersionSpec^ version, 
    RecursionType recursion, 
    DeletedState deletedState, 
    ItemType itemType, 
    bool includeDownloadInfo
)

public function GetItems(
    path : String, 
    version : VersionSpec, 
    recursion : RecursionType, 
    deletedState : DeletedState, 
    itemType : ItemType, 
    includeDownloadInfo : boolean
) : ItemSet

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.

• version
  Type: Microsoft.TeamFoundation.VersionControl.Client.VersionSpec

  The version of the passed item. (This is not necessarily the version numbers of the getd items. For instance, if you do a recursive GetItems on version 12 of $/CmdLine, you may get version 84 of $/CmdLine/parse.cs, and version 1 of $/CmdLine/output.cs, and so on.) You must use VersionSpec.Latest to get the current version of all items.

• recursion
  Type: Microsoft.TeamFoundation.VersionControl.Client.RecursionType

  The recursion parameter determines what files and folders that you want to get. RecursionType.None gets the passed items only; if you passed in $/CmdLine then you will get only the folder $/CmdLine. RecursionType.OneLevel examines the passed items and, in the case of folders, their children; if you passed in $/CmdLine you will get the files and folders directly inside that folder. RecursionType.Full examines the full tree; if you passed in $/CmdLine/parser.cs you will get all files called parser.cs inside $/CmdLine or any folder under it.

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

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

  This applies to the getd items, not to the items you passed in, so you could pass in a non-deleted folder, but want to get the deleted files in it.

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

  The ItemType.Folder from which you want to get folders, the ItemType.File from which you want to get files, or the ItemType.Any from which you want to get both.

• includeDownloadInfo
  Type: System.Boolean

  If you set includeDownloadInfo to true, the returned Item objects will contain information required to download files. This makes the initial GetItems call slower, so should only be used if you want to download files using the returned objects.

Return Value

Type: Microsoft.TeamFoundation.VersionControl.Client.ItemSet
The returned ItemSet contains a QueryPath (which is null if the searched path was not valid), the matched pattern, and an array of Item objects for all the items that were getd.

Remarks

If the path argument is a file, it returns a set of Items that contains 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.

Only set includeDownloadInfo to true if you want to download the files by using the returned objects. The call will be faster and require less bandwidth when this parameter is set to false. The overload methods set includeDownloadInfo to false.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

VersionControlServer Class

VersionControlServer Members

GetItems Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace