SourceControl.CheckOutItem(String) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Checks the specified item out of source control.
public:
bool CheckOutItem(System::String ^ ItemName);
public:
bool CheckOutItem(Platform::String ^ ItemName);
bool CheckOutItem(std::wstring const & ItemName);
[System.Runtime.InteropServices.DispId(5)]
public bool CheckOutItem (string ItemName);
[<System.Runtime.InteropServices.DispId(5)>]
abstract member CheckOutItem : string -> bool
Public Function CheckOutItem (ItemName As String) As Boolean
Parameters
- ItemName
- String
The full path to the file to check out.
Returns
A Boolean value indicating true
if the item was successfully checked out; otherwise, false
.
- Attributes
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.