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

Schedules a file or folder for branching.

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 _
) As Integer

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

public:
int PendBranch(
    String^ sourcePath, 
    String^ targetPath, 
    VersionSpec^ version, 
    LockLevel lockLevel, 
    bool updateDisk, 
    bool detectFolderAtTarget
)

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

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

Parameters

• sourcePath
  Type: System.String
  The path of the item to branch.

• targetPath
  Type: System.String
  The location of the branch that will be created.

• version
  Type: Microsoft.TeamFoundation.VersionControl.Client.VersionSpec
  The version of the source item to branch.

• lockLevel
  Type: Microsoft.TeamFoundation.VersionControl.Client.LockLevel
  The lock level to apply to each branched item.

• updateDisk
  Type: System.Boolean
  True to populate the branch on local disk. Otherwise, the disk is not modified.

• detectFolderAtTarget
  Type: System.Boolean
  True to search for a local folder that exists at the target and then notify the server. False to not search.

Return Value

Type: System.Int32
The number of pending changes.

Remarks

Branching a folder is implicitly recursive.

.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