FDownloadFile | Unreal Engine 5.2 Documentation

API > API/Developer > API/Developer/SourceControl

Inheritance Hierarchy

References


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

Syntax

class FDownloadFile : public FSourceControlOperationBase

Remarks

Operation used to download a file from the source control server directly rather than sync it. This should not change the state of anything locally on the client.

Constructors

	Type	Name	Description
		FDownloadFile ()	This version of FDownloadFile will download the files and keep them in memory, which can then be accessed by calling ::GetFileData.
		FDownloadFile ( EVerbosity InVerbosity )	This version of FDownloadFile will download the files and keep them in memory, which can then be accessed by calling ::GetFileData.
		FDownloadFile ( FStringView InTargetDirectory, EVerbosity InVerbosity )	This version of FDownloadFile will download the files to the given target directory

Functions

Type	Name	Description
void	__Internal_AddFileData ( const FString& Filename, FSharedBuffer FileData )	Do not call outside of source control implementations.
FSharedBuffer	GetFileData ( const FStringView& Filename )	If no target directory was given to download the files too then the command will keep the files in memory which can be accessed via this method.
FString	GetTargetDirectory ()	Returns the directory that the files will (or have) been downloaded to.
bool	ShouldLogToStdOutput ()	Return true if the command should log its operations, otherwise false

Overridden from ISourceControlOperation

Type	Name	Description
bool	CanBeCalledFromBackgroundThreads ()	This will return true if the operation can be safely called from a background thread.
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