ISourceControlProvider::Login

Login to the source control server (if any).

Windows
MacOS
Linux

References

Module

SourceControl

Header

/Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h

Include

#include "ISourceControlProvider.h"

Source

/Engine/Source/Developer/SourceControl/Private/ISourceControlProvider.cpp

Syntax

virtual ECommandResult::Type Login
(
    const FString & InPassword,
    EConcurrency::Type InConcurrency,
    const FSourceControlOperationComplete & InOperationCompleteDelegate
)

Remarks

Login to the source control server (if any). This is just a wrapper around Execute().

Returns

the result of the operation.

Parameters

Parameter

Description

InPassword

The password (if required) to use when logging in.

InConcurrency

How to execute the operation, blocking or asynchronously on another thread.

InOperationCompleteDelegate

Delegate to call when the operation is completed. This is called back internal to this call when executed on the main thread, or from Tick() when queued for asynchronous execution. If the provider is not enabled or if the command is not suported the delegate is immediately called with ECommandResult::Failed.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss