SourceControl.CheckOutItem Method

Checks the specified item out of source control.

Namespace:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

Syntax

'Declaration
Function CheckOutItem ( _
    ItemName As String _
) As Boolean

bool CheckOutItem(
    string ItemName
)

bool CheckOutItem(
    [InAttribute] String^ ItemName
)

abstract CheckOutItem : 
        ItemName:string -> bool 

function CheckOutItem(
    ItemName : String
) : boolean

Parameters

• ItemName
  Type: System.String
  The full path to the file to check out.

Return Value

Type: System.Boolean
A Boolean value indicating true if the item was successfully checked out; otherwise, false.

Remarks

CheckOutItem checks out a project item that is under source control. This checks it out via the owning project and returns whether the checkout was successful.

.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

SourceControl Interface

EnvDTE Namespace