Workspace.PendBranch Method (String, String, VersionSpec, LockLevel, Boolean, Boolean, Boolean, array<String )

Schedules a file or folder for branching (branching occurs at check in). Branching a folder is implicitly recursive.

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

Syntax

'Declaration
Public Function PendBranch ( _
    sourcePath As String, _
    targetPath As String, _
    version As VersionSpec, _
    lockLevel As LockLevel, _
    updateDisk As Boolean, _
    detectFolderAtTarget As Boolean, _
    silent As Boolean, _
    itemPropertyFilters As String() _
) As Integer

public int PendBranch(
    string sourcePath,
    string targetPath,
    VersionSpec version,
    LockLevel lockLevel,
    bool updateDisk,
    bool detectFolderAtTarget,
    bool silent,
    string[] itemPropertyFilters
)

public:
int PendBranch(
    String^ sourcePath, 
    String^ targetPath, 
    VersionSpec^ version, 
    LockLevel lockLevel, 
    bool updateDisk, 
    bool detectFolderAtTarget, 
    bool silent, 
    array<String^>^ itemPropertyFilters
)

member PendBranch : 
        sourcePath:string * 
        targetPath:string * 
        version:VersionSpec * 
        lockLevel:LockLevel * 
        updateDisk:bool * 
        detectFolderAtTarget:bool * 
        silent:bool * 
        itemPropertyFilters:string[] -> int

public function PendBranch(
    sourcePath : String, 
    targetPath : String, 
    version : VersionSpec, 
    lockLevel : LockLevel, 
    updateDisk : boolean, 
    detectFolderAtTarget : boolean, 
    silent : boolean, 
    itemPropertyFilters : String[]
) : int

Parameters

• sourcePath
  Type: System.String

  the item to branch

• targetPath
  Type: System.String

  the location for the branch that will be created

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

  the version to branch

• lockLevel
  Type: Microsoft.TeamFoundation.VersionControl.Client.LockLevel

  the lock level to apply to each file checked out

• updateDisk
  Type: System.Boolean

  if true, populate the branch on disk; otherwise, the disk is not modified

• detectFolderAtTarget
  Type: System.Boolean

  if true, look for a local folder existing at the target and tell the server if that is the case; otherwise, do not check

• silent
  Type: System.Boolean

  Specifies whether server should return get ops

• itemPropertyFilters
  Type: array<System.String[]

Return Value

Type: System.Int32
the number of pending changes

.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

Workspace Class

PendBranch Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace