VersionControlServer.GetItem Method (String, VersionSpec, Int32, Boolean)

Gets the Item at the specified path.

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

Syntax

'Declaration
Public Function GetItem ( _
    path As String, _
    version As VersionSpec, _
    deletionId As Integer, _
    includeDownloadInfo As Boolean _
) As Item
public Item GetItem(
    string path,
    VersionSpec version,
    int deletionId,
    bool includeDownloadInfo
)
public:
Item^ GetItem(
    String^ path, 
    VersionSpec^ version, 
    int deletionId, 
    bool includeDownloadInfo
)
member GetItem : 
        path:string * 
        version:VersionSpec * 
        deletionId:int * 
        includeDownloadInfo:bool -> Item
public function GetItem(
    path : String, 
    version : VersionSpec, 
    deletionId : int, 
    includeDownloadInfo : boolean
) : Item

Parameters

  • path
    Type: System.String

    The path to the item, may be server or local.

  • deletionId
    Type: System.Int32

    The deletion ID of the specified item.

  • includeDownloadInfo
    Type: System.Boolean

    True to get the information needed to download files. Specify false to save bandwidth if not necessary.

Return Value

Type: Microsoft.TeamFoundation.VersionControl.Client.Item
The specified Item. Throws an exception if an item is not found.

Remarks

Only set includeDownloadInfo to true if you are going to be downloading the files using the objects that are returned. The call will be faster and require less bandwidth when includeDownloadInfo is false (default for overloads that don't specify it).

.NET Framework Security

See Also

Reference

VersionControlServer Class

GetItem Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace