VersionControlServer.GetItem Method (String, VersionSpec, DeletedState, 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, _
    deletedState As DeletedState, _
    includeDownloadInfo As Boolean _
) As Item

public Item GetItem(
    string path,
    VersionSpec version,
    DeletedState deletedState,
    bool includeDownloadInfo
)

public:
Item^ GetItem(
    String^ path, 
    VersionSpec^ version, 
    DeletedState deletedState, 
    bool includeDownloadInfo
)

member GetItem : 
        path:string * 
        version:VersionSpec * 
        deletedState:DeletedState * 
        includeDownloadInfo:bool -> Item

public function GetItem(
    path : String, 
    version : VersionSpec, 
    deletedState : DeletedState, 
    includeDownloadInfo : boolean
) : Item

Parameters

• path
  Type: System.String

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

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

  The version of the item.

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

  A flag describing to return deleted items and/or non-deleted items.

• 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

• 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

GetItem Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace