USourceControlHelpers::CheckoutOrMarkForAdd

Helper function perform an operation on files in our 'source controlled' directories, handling checkout/add etc.

Unreal Engine C++ API Reference > Developer > SourceControl > USourceControlHelpers

References

   
Module SourceControl
Header /Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h
Include #include "SourceControlHelpers.h"
Source /Engine/Source/Developer/SourceControl/Private/SourceControlHelpers.cpp
static bool CheckoutOrMarkForAdd
(
    const [FString](API\Runtime\Core\Containers\FString) & InDestFile,
    const [FText](API\Runtime\Core\Internationalization\FText) & InFileDescription,
    const [FOnPostCheckOut](API\Developer\SourceControl\FOnPostCheckOut) & OnPostCheckOut,
    [FText](API\Runtime\Core\Internationalization\FText) & OutFailReason
)

Remarks

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(). Success or failure of the operation

Parameters

Name Description
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

See Also

CheckOutOrAddFile()


Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library