USourceControlHelpers::CheckInFile

Use currently set source control provider to check in a file.

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 CheckInFile
(
    const FString & InFile,
    const FString & InDescription,
    bool bSilent
)

Remarks

Use currently set source control provider to check in a file. @note Blocks until action is complete.

Returns

true if succeeded, false if failed and can call LastErrorMsg() for more info.

Parameters

Parameter

Description

InFile

The file to check in - can be either fully qualified path, relative path, long package name, asset path or export text path (often stored on clipboard)

InDescription

Description for check in

bSilent

if false (default) then write out any error info to the Log. Any error text can be retrieved by LastErrorMsg() regardless.

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