Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Developer > SourceControl > USourceControlHelpers > USourceControlHelpers::CheckoutOrMarkForAdd

Light Theme

Dark Theme

USourceControlHelpers::CheckoutOrMarkForAdd

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

Windows

MacOS

Linux

References

Module	SourceControl
Header	/Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h
Include	#include "SourceControlHelpers.h"
Source	/Engine/Source/Developer/SourceControl/Private/SourceControlHelpers.cpp

Syntax

static bool CheckoutOrMarkForAdd
(
    const FString & InDestFile,
    const FText & InFileDescription,
    const FOnPostCheckOut & OnPostCheckOut,
    FText & OutFailReason
)

Remarks

Helper function perform an operation on files in our 'source controlled' directories, handling checkout/add etc. @note Blocks until action is complete. Older C++ only version of CheckOutOrAddFile().

Returns

Success or failure of the operation

Parameters

Parameter	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