USourceControlHelpers::CopyFileUnderSourceControl

Helper function to copy a file into 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 CopyFileUnderSourceControl
(
    const FString & InDestFile,
    const FString & InSourceFile,
    const FText & InFileDescription,
    FText & OutFailReason
)

Remarks

Helper function to copy a file into our 'source controlled' directories, handling checkout/add etc. @note Blocks until action is complete. Older C++ only version of CopyFile().

Returns

Success or failure of the operation

Parameters

Parameter

Description

InDestFile

The path to the destination file

InSourceFile

The path to the source file

InFileDescription

Description of the file to display to the user, e.g. "Text" or "Image"

OutFailReason

Text describing why the operation failed
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss