Navigation
API > API/Developer > API/Developer/SourceControl > API/Developer/SourceControl/USourceControlHelpers
Description
Helper function perform an operation on files in our 'source controlled' directories, handling checkout/add etc.
Blocks until action is complete. Older C++ only version of CheckOutOrAddFile().
| Name | CheckoutOrMarkForAdd |
| Type | function |
| Header File | /Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h |
| Include Path | #include "SourceControlHelpers.h" |
| Source | /Engine/Source/Developer/SourceControl/Private/SourceControlHelpers.cpp |
static bool CheckoutOrMarkForAdd
(
const FString & InDestFile,
const FText & InFileDescription,
const FOnPostCheckOut & OnPostCheckOut,
FText & OutFailReason
)
Success or failure of the operation
Parameters
| Name | Remarks |
|---|---|
| InDestFile | The path to the destination file |
| InFileDescription | Description of the file to display to the user, e.g. "Text" or "Image" |
| OnPostCheckOut | Delegate used for performing operation on files that may need a checkout, but before they are added to source control |
| OutFailReason | Text describing why the operation failed |