Navigation
API > API/Developer > API/Developer/SourceControl > API/Developer/SourceControl/ISourceControlProvider
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool TryToDownloadFileFromBackgroundThread
(
const TSharedRef< class FDownloadFile >& InOperation, |
Executes the FDownloadFile operation, but unlike the Execute method this can be called from a background thread, this works because FDownloadFile is thread safe and it does not change the state of source control. | ISourceControlProvider.h | |
virtual bool TryToDownloadFileFromBackgroundThread
(
const TSharedRef< class FDownloadFile >& InOperation, |
Executes the FDownloadFile operation, but unlike the Execute method this can be called from a background thread, this works because FDownloadFile is thread safe and it does not change the state of source control. | ISourceControlProvider.h |
TryToDownloadFileFromBackgroundThread(const TSharedRef< class FDownloadFile > &, const FString &)
Description
Executes the FDownloadFile operation, but unlike the Execute method this can be called from a background thread, this works because FDownloadFile is thread safe and it does not change the state of source control. NOTE: This is only intended for use by the virtualization module and will be deprecated at some point in the future when thread safety is built into the system. NOTE: This is only implemented for the perforce source control provider with no plans to extend this to other providers.
| Name | TryToDownloadFileFromBackgroundThread |
| Type | function |
| Header File | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h |
| Include Path | #include "ISourceControlProvider.h" |
| Source | /Engine/Source/Developer/SourceControl/Private/ISourceControlProvider.cpp |
bool TryToDownloadFileFromBackgroundThread
(
const TSharedRef < class FDownloadFile > & InOperation,
const FString & InFile
)
True if the operation was a success, otherwise false.
Parameters
| Name | Remarks |
|---|---|
| InOperation | The download operation to be executed. |
| InFile | The depot path of a file to download. |
TryToDownloadFileFromBackgroundThread(const TSharedRef< class FDownloadFile > &, const TArray< FString > &)
Description
Executes the FDownloadFile operation, but unlike the Execute method this can be called from a background thread, this works because FDownloadFile is thread safe and it does not change the state of source control. NOTE: This is only intended for use by the virtualization module and will be deprecated at some point in the future when thread safety is built into the system. NOTE: This is only implemented for the perforce source control provider with no plans to extend this to other providers.
| Name | TryToDownloadFileFromBackgroundThread |
| Type | function |
| Header File | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h |
| Include Path | #include "ISourceControlProvider.h" |
| Source | /Engine/Source/Developer/SourceControl/Private/ISourceControlProvider.cpp |
virtual bool TryToDownloadFileFromBackgroundThread
(
const TSharedRef < class FDownloadFile > & InOperation,
const TArray < FString > & InFiles
)
True if the operation was a success, otherwise false.
Parameters
| Name | Remarks |
|---|---|
| InOperation | The download operation to be executed. |
| InFile | An array of depot paths for the files to download. |