USourceControlHelpers::QueryFileState

Use currently set source control provider to query a file's source control state.

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

Remarks

Use currently set source control provider to query a file's source control state.

Blocks until action is complete.

Returns

Source control state - see USourceControlState. It will have bIsValid set to false if it could not have its values set.

Parameters

Parameter

Description

InFile

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

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