FSourceControlFileStatusMonitor::StartMonitoringFile

Starts monitoring the source control status of the specified file.

Unreal Engine C++ API Reference > Developer > SourceControl > FSourceControlFileStatusMonitor

References

   
Module SourceControl
Header /Engine/Source/Developer/SourceControl/Public/SourceControlFileStatusMonitor.h
Include #include "SourceControlFileStatusMonitor.h"
Source /Engine/Source/Developer/SourceControl/Private/SourceControlFileStatusMonitor.cpp
void StartMonitoringFile
(
    uintptr_t OwnerId,
    const [FString](API\Runtime\Core\Containers\FString) & AbsPathname,
    [FOnSourceControlFileStatus](API\Developer\SourceControl\FSourceControlFileStatusMonitor\FOnSourceControl-) OnSourceControlledFileStatus
)

Remarks

Starts monitoring the source control status of the specified file. If the status is already known (the file is already monitored by another party), the know status is returned right away, otherwise a request is sent to the source control provider to get the status. The request is subject to the probation period policy to allow batching requests. The file status is refreshed according to the refresh period policy.

The caller must be sure to call StopMonitoringFile() when the files status is not desired anymore. It is ok to call StopMonitoringFile() within the callback OnSourceControlledFileStatus().

Parameters

Name Description
Owner The unique Id of the caller, typically the caller memory address.
AbsPathname The absolute path and filname of the file to monitor.
OnSourceControlledFileStatus Delegate invoked whe the status of the file is updated.

See Also

SetNewRequestProbationPeriod()

SetUpdateStatusPeriod()

SetSuspendMonitoringPolicy()

GetStatusAge()


Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library