Share via


SourceControl2.CheckOutItem Method

Checks the specified item out of source control.

Namespace:  EnvDTE80
Assembly:  EnvDTE80 (in EnvDTE80.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 pathname to the file to check out.

Return Value

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

Remarks

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

See Also

Reference

SourceControl2 Interface

EnvDTE80 Namespace