ISourceControlProvider::TryToDownloadFileFromBackgroundThread

Executes the [FDownloadFile](API\Developer\SourceControl\FDownloadFile) operation, but unlike the [Execute](API\Plugins\RigVM\RigVMCore\ERigVMOpCode) method this can be called from a background thread, this works because [FDownloadFile](API\Developer\SourceControl\FDownloadFile) is thread safe and it does not change the state of source control.

Unreal Engine C++ API Reference > Developer > SourceControl > ISourceControlProvider > TryToDownloadFileFromBackgroundThread

References

   
Module SourceControl
Header /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h
Include #include "ISourceControlProvider.h"
Source /Engine/Source/Developer/SourceControl/Private/ISourceControlProvider.cpp
bool TryToDownloadFileFromBackgroundThread
(
    const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [FDownloadFile](API\Developer\SourceControl\FDownloadFile) > & InOperation,
    const [FString](API\Runtime\Core\Containers\FString) & InFile
)

Remarks

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. True if the operation was a success, otherwise false.

Parameters

Name Description
InOperation The download operation to be executed.
InFile The depot path of a file to download.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library