Navigation
API > API/Developer > API/Developer/SourceControl
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.
| Name | FDownloadFile |
| Type | class |
| Header File | /Engine/Source/Developer/SourceControl/Public/SourceControlOperations.h |
| Include Path | #include "SourceControlOperations.h" |
Syntax
class FDownloadFile : public FSourceControlOperationBase
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| This version of FDownloadFile will download the files and keep them in memory, which can then be accessed by calling GetFileData. | SourceControlOperations.h | ||
PRAGMA_DISABLE_DEPRECATION_WARNINGS FDownloadFile
(
EVerbosity InVerbosity |
SourceControlOperations.h | ||
FDownloadFile
(
FStringView InTargetDirectory |
This version of FDownloadFile will download the files to the given target directory | SourceControlOperations.h | |
PRAGMA_DISABLE_DEPRECATION_WARNINGS FDownloadFile
(
FStringView InTargetDirectory, |
SourceControlOperations.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| FileDataMap | TMap< FString, FSharedBuffer > | SourceControlOperations.h | ||
| TargetDirectory | FString | SourceControlOperations.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void __Internal_AddFileData
(
const FString& Filename, |
Do not call outside of source control implementations. | SourceControlOperations.h | |
void AddFileData
(
const FString& Filename, |
SourceControlOperations.h | ||
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. | SourceControlOperations.h | |
FString GetTargetDirectory () |
Returns the directory that the files will (or have) been downloaded to. | SourceControlOperations.h | |
bool ShouldLogToStdOutput() |
Return true if the command should log its operations, otherwise false | SourceControlOperations.h |
Overridden from ISourceControlOperation
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanBeCalledFromBackgroundThreads () |
This will return true if the operation can be safely called from a background thread. | SourceControlOperations.h | |
virtual FText GetInProgressString() |
Get the string to display when this operation is in progress | SourceControlOperations.h | |
virtual FName GetName() |
Get the name of this operation, used as a unique identifier | SourceControlOperations.h |