FUpdateStatus

Operation used to update the source control status of files

Unreal Engine C++ API Reference > Developer > SourceControl

Inheritance Hierarchy

References

   
Module SourceControl
Header /Engine/Source/Developer/SourceControl/Public/SourceControlOperations.h
Include #include "SourceControlOperations.h"

Syntax

class FUpdateStatus : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)  

Remarks

Operation used to update the source control status of files

Variables

Type Name Description
bool bCheckingAllFiles Hint that we are intending on checking all files in the project - some providers can optimize for this
bool bForceQuiet Controls whether the operation will trigger an update or not
bool bForceUpdate Forces the verification for provided files - providers can ignore files not opened/edited without it
bool bGetOpenedOnly Whether to just get files that are opened/edited
bool bSetRequireDirPathEndWithSeparator If we should assume paths ending in a separator are directory paths or do we need to check with the file system?
bool bUpdateHistory Whether to update history
bool bUpdateModifiedState Whether to update the modified state - expensive
bool bUpdateModifiedStateToLocalRevision Whether to update the modified state against local revision - only used when bUpdateModifiedState is true

Constructors

Type Name Description
  FUpdateStatus ()  

Functions

Type Name Description
bool IsDirectoryPath ( const FString& Path ) Returns if the given path should be considered a directory or not.
void SetCheckingAllFiles ( bool bInCheckingAllFiles )  
void SetForceUpdate ( const bool bInForceUpdate )  
void SetGetOpenedOnly ( bool bInGetOpenedOnly )  
void SetQuiet ( bool bInQuiet )  
void SetRequireDirPathEndWithSeparator ( bool bFlag ) Sets the method that the operation will use to determine if a path references a file or a directory.
void SetUpdateHistory ( bool bInUpdateHistory )  
void SetUpdateModifiedState ( bool bInUpdateModifiedState )  
void SetUpdateModifiedStateToLocalRevision ( bool bInUpdateModifiedStateToLocalR... )  
bool ShouldBeQuiet ()  
bool ShouldCheckAllFiles ()  
bool ShouldForceUpdate ()  
bool ShouldGetOpenedOnly ()  
bool ShouldUpdateHistory ()  
bool ShouldUpdateModifiedState ()  
bool ShouldUpdateModifiedStateToLocalRevision ()  

Overridden from ISourceControlOperation

Type Name Description
FText GetInProgressString () Get the string to display when this operation is in progress
FName GetName () Get the name of this operation, used as a unique identifier

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library