FSourceControlWindows::PromptForCheckin

Display check in dialog for the specified packages and get additional result information

Windows
MacOS
Linux

References

Module

SourceControlWindows

Header

/Engine/Source/Editor/SourceControlWindows/Public/SourceControlWindows.h

Include

#include "SourceControlWindows.h"

Source

/Engine/Source/Editor/SourceControlWindows/Private/SourceControlWindows.cpp

Syntax

static bool PromptForCheckin
(
    FCheckinResultInfo & OutResultInfo,
    const TArray< FString > & InPackageNames,
    const TArray< FString > & InPendingDeletePaths,
    const TArray< FString > & InConfigFiles,
    bool bUseSourceControlStateCache
)

Remarks

Display check in dialog for the specified packages and get additional result information

Returns

true - if completed successfully in progress and OnCompleteDelegate will be called when complete, false - if immediately unable to comply (such as source control not enabled)

Parameters

Parameter

Description

OutResultInfo

Optional FCheckinResultInfo to store information about checked in files and whether the check in was successful

InPackageNames

Names of packages to check in

InPendingDeletePaths

Directories to check for files marked 'pending delete'

InConfigFiles

Config filenames to check in

bUseSourceControlStateCache

Whether to use the cached source control status, or force the status to be updated

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